Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-automation

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

ActivityGetResponse

ActivityGetResponse: Activity & object

Contains response data for the get operation.

ActivityListByModuleNextResponse

ActivityListByModuleNextResponse: ActivityListResult & object

Contains response data for the listByModuleNext operation.

ActivityListByModuleResponse

ActivityListByModuleResponse: ActivityListResult & object

Contains response data for the listByModule operation.

AgentRegistrationInformationGetResponse

AgentRegistrationInformationGetResponse: AgentRegistration & object

Contains response data for the get operation.

AgentRegistrationInformationRegenerateKeyResponse

AgentRegistrationInformationRegenerateKeyResponse: AgentRegistration & object

Contains response data for the regenerateKey operation.

AgentRegistrationKeyName

AgentRegistrationKeyName: "primary" | "secondary"

Defines values for AgentRegistrationKeyName. Possible values include: 'primary', 'secondary'

readonly
enum

{string}

AutomationAccountCreateOrUpdateResponse

AutomationAccountCreateOrUpdateResponse: AutomationAccount & object

Contains response data for the createOrUpdate operation.

AutomationAccountGetResponse

AutomationAccountGetResponse: AutomationAccount & object

Contains response data for the get operation.

AutomationAccountListByResourceGroupNextResponse

AutomationAccountListByResourceGroupNextResponse: AutomationAccountListResult & object

Contains response data for the listByResourceGroupNext operation.

AutomationAccountListByResourceGroupResponse

AutomationAccountListByResourceGroupResponse: AutomationAccountListResult & object

Contains response data for the listByResourceGroup operation.

AutomationAccountListNextResponse

AutomationAccountListNextResponse: AutomationAccountListResult & object

Contains response data for the listNext operation.

AutomationAccountListResponse

AutomationAccountListResponse: AutomationAccountListResult & object

Contains response data for the list operation.

AutomationAccountState

AutomationAccountState: "Ok" | "Unavailable" | "Suspended"

Defines values for AutomationAccountState. Possible values include: 'Ok', 'Unavailable', 'Suspended'

readonly
enum

{string}

AutomationAccountUpdateResponse

AutomationAccountUpdateResponse: AutomationAccount & object

Contains response data for the update operation.

AutomationKeyName

AutomationKeyName: "Primary" | "Secondary"

Defines values for AutomationKeyName. Possible values include: 'Primary', 'Secondary'

readonly
enum

{string}

AutomationKeyPermissions

AutomationKeyPermissions: "Read" | "Full"

Defines values for AutomationKeyPermissions. Possible values include: 'Read', 'Full'

readonly
enum

{string}

CertificateCreateOrUpdateResponse

CertificateCreateOrUpdateResponse: Certificate & object

Contains response data for the createOrUpdate operation.

CertificateGetResponse

CertificateGetResponse: Certificate & object

Contains response data for the get operation.

CertificateListByAutomationAccountNextResponse

CertificateListByAutomationAccountNextResponse: CertificateListResult & object

Contains response data for the listByAutomationAccountNext operation.

CertificateListByAutomationAccountResponse

CertificateListByAutomationAccountResponse: CertificateListResult & object

Contains response data for the listByAutomationAccount operation.

CertificateUpdateResponse

CertificateUpdateResponse: Certificate & object

Contains response data for the update operation.

ConnectionCreateOrUpdateResponse

ConnectionCreateOrUpdateResponse: Connection & object

Contains response data for the createOrUpdate operation.

ConnectionDeleteMethodResponse

ConnectionDeleteMethodResponse: Connection & object

Contains response data for the deleteMethod operation.

ConnectionGetResponse

ConnectionGetResponse: Connection & object

Contains response data for the get operation.

ConnectionListByAutomationAccountNextResponse

ConnectionListByAutomationAccountNextResponse: ConnectionListResult & object

Contains response data for the listByAutomationAccountNext operation.

ConnectionListByAutomationAccountResponse

ConnectionListByAutomationAccountResponse: ConnectionListResult & object

Contains response data for the listByAutomationAccount operation.

ConnectionTypeCreateOrUpdateResponse

ConnectionTypeCreateOrUpdateResponse: ConnectionType & object

Contains response data for the createOrUpdate operation.

ConnectionTypeGetResponse

ConnectionTypeGetResponse: ConnectionType & object

Contains response data for the get operation.

ConnectionTypeListByAutomationAccountNextResponse

ConnectionTypeListByAutomationAccountNextResponse: ConnectionTypeListResult & object

Contains response data for the listByAutomationAccountNext operation.

ConnectionTypeListByAutomationAccountResponse

ConnectionTypeListByAutomationAccountResponse: ConnectionTypeListResult & object

Contains response data for the listByAutomationAccount operation.

ConnectionUpdateResponse

ConnectionUpdateResponse: Connection & object

Contains response data for the update operation.

ContentSourceType

ContentSourceType: "embeddedContent" | "uri"

Defines values for ContentSourceType. Possible values include: 'embeddedContent', 'uri'

readonly
enum

{string}

CountType

CountType: "status" | "nodeconfiguration"

Defines values for CountType. Possible values include: 'status', 'nodeconfiguration'

readonly
enum

{string}

CredentialCreateOrUpdateResponse

CredentialCreateOrUpdateResponse: Credential & object

Contains response data for the createOrUpdate operation.

CredentialGetResponse

CredentialGetResponse: Credential & object

Contains response data for the get operation.

CredentialListByAutomationAccountNextResponse

CredentialListByAutomationAccountNextResponse: CredentialListResult & object

Contains response data for the listByAutomationAccountNext operation.

CredentialListByAutomationAccountResponse

CredentialListByAutomationAccountResponse: CredentialListResult & object

Contains response data for the listByAutomationAccount operation.

CredentialUpdateResponse

CredentialUpdateResponse: Credential & object

Contains response data for the update operation.

DscCompilationJobBeginCreateResponse

DscCompilationJobBeginCreateResponse: DscCompilationJob & object

Contains response data for the beginCreate operation.

DscCompilationJobCreateResponse

DscCompilationJobCreateResponse: DscCompilationJob & object

Contains response data for the create operation.

DscCompilationJobGetResponse

DscCompilationJobGetResponse: DscCompilationJob & object

Contains response data for the get operation.

DscCompilationJobGetStreamResponse

DscCompilationJobGetStreamResponse: JobStream & object

Contains response data for the getStream operation.

DscCompilationJobListByAutomationAccountNextResponse

DscCompilationJobListByAutomationAccountNextResponse: DscCompilationJobListResult & object

Contains response data for the listByAutomationAccountNext operation.

DscCompilationJobListByAutomationAccountResponse

DscCompilationJobListByAutomationAccountResponse: DscCompilationJobListResult & object

Contains response data for the listByAutomationAccount operation.

DscCompilationJobStreamListByJobResponse

DscCompilationJobStreamListByJobResponse: JobStreamListResult & object

Contains response data for the listByJob operation.

DscConfigurationCreateOrUpdateResponse

DscConfigurationCreateOrUpdateResponse: DscConfiguration & object

Contains response data for the createOrUpdate operation.

DscConfigurationGetContentResponse

DscConfigurationGetContentResponse: object

Contains response data for the getContent operation.

Type declaration

DscConfigurationGetResponse

DscConfigurationGetResponse: DscConfiguration & object

Contains response data for the get operation.

DscConfigurationListByAutomationAccountNextResponse

DscConfigurationListByAutomationAccountNextResponse: DscConfigurationListResult & object

Contains response data for the listByAutomationAccountNext operation.

DscConfigurationListByAutomationAccountResponse

DscConfigurationListByAutomationAccountResponse: DscConfigurationListResult & object

Contains response data for the listByAutomationAccount operation.

DscConfigurationProvisioningState

DscConfigurationProvisioningState: "Succeeded"

Defines values for DscConfigurationProvisioningState. Possible values include: 'Succeeded'

readonly
enum

{string}

DscConfigurationState

DscConfigurationState: "New" | "Edit" | "Published"

Defines values for DscConfigurationState. Possible values include: 'New', 'Edit', 'Published'

readonly
enum

{string}

DscConfigurationUpdateResponse

DscConfigurationUpdateResponse: DscConfiguration & object

Contains response data for the update operation.

DscNodeConfigurationBeginCreateOrUpdateResponse

DscNodeConfigurationBeginCreateOrUpdateResponse: DscNodeConfiguration & object

Contains response data for the beginCreateOrUpdate operation.

DscNodeConfigurationCreateOrUpdateResponse

DscNodeConfigurationCreateOrUpdateResponse: DscNodeConfiguration & object

Contains response data for the createOrUpdate operation.

DscNodeConfigurationGetResponse

DscNodeConfigurationGetResponse: DscNodeConfiguration & object

Contains response data for the get operation.

DscNodeConfigurationListByAutomationAccountNextResponse

DscNodeConfigurationListByAutomationAccountNextResponse: DscNodeConfigurationListResult & object

Contains response data for the listByAutomationAccountNext operation.

DscNodeConfigurationListByAutomationAccountResponse

DscNodeConfigurationListByAutomationAccountResponse: DscNodeConfigurationListResult & object

Contains response data for the listByAutomationAccount operation.

DscNodeDeleteMethodResponse

DscNodeDeleteMethodResponse: DscNode & object

Contains response data for the deleteMethod operation.

DscNodeGetResponse

DscNodeGetResponse: DscNode & object

Contains response data for the get operation.

DscNodeListByAutomationAccountNextResponse

DscNodeListByAutomationAccountNextResponse: DscNodeListResult & object

Contains response data for the listByAutomationAccountNext operation.

DscNodeListByAutomationAccountResponse

DscNodeListByAutomationAccountResponse: DscNodeListResult & object

Contains response data for the listByAutomationAccount operation.

DscNodeUpdateResponse

DscNodeUpdateResponse: DscNode & object

Contains response data for the update operation.

FieldsListByTypeResponse

FieldsListByTypeResponse: TypeFieldListResult & object

Contains response data for the listByType operation.

GroupTypeEnum

GroupTypeEnum: "User" | "System"

Defines values for GroupTypeEnum. Possible values include: 'User', 'System'

readonly
enum

{string}

HttpStatusCode

HttpStatusCode: "Continue" | "SwitchingProtocols" | "OK" | "Created" | "Accepted" | "NonAuthoritativeInformation" | "NoContent" | "ResetContent" | "PartialContent" | "MultipleChoices" | "Ambiguous" | "MovedPermanently" | "Moved" | "Found" | "Redirect" | "SeeOther" | "RedirectMethod" | "NotModified" | "UseProxy" | "Unused" | "TemporaryRedirect" | "RedirectKeepVerb" | "BadRequest" | "Unauthorized" | "PaymentRequired" | "Forbidden" | "NotFound" | "MethodNotAllowed" | "NotAcceptable" | "ProxyAuthenticationRequired" | "RequestTimeout" | "Conflict" | "Gone" | "LengthRequired" | "PreconditionFailed" | "RequestEntityTooLarge" | "RequestUriTooLong" | "UnsupportedMediaType" | "RequestedRangeNotSatisfiable" | "ExpectationFailed" | "UpgradeRequired" | "InternalServerError" | "NotImplemented" | "BadGateway" | "ServiceUnavailable" | "GatewayTimeout" | "HttpVersionNotSupported"

Defines values for HttpStatusCode. Possible values include: 'Continue', 'SwitchingProtocols', 'OK', 'Created', 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', 'PartialContent', 'MultipleChoices', 'Ambiguous', 'MovedPermanently', 'Moved', 'Found', 'Redirect', 'SeeOther', 'RedirectMethod', 'NotModified', 'UseProxy', 'Unused', 'TemporaryRedirect', 'RedirectKeepVerb', 'BadRequest', 'Unauthorized', 'PaymentRequired', 'Forbidden', 'NotFound', 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', 'PreconditionFailed', 'RequestEntityTooLarge', 'RequestUriTooLong', 'UnsupportedMediaType', 'RequestedRangeNotSatisfiable', 'ExpectationFailed', 'UpgradeRequired', 'InternalServerError', 'NotImplemented', 'BadGateway', 'ServiceUnavailable', 'GatewayTimeout', 'HttpVersionNotSupported'

readonly
enum

{string}

HybridRunbookWorkerGroupGetResponse

HybridRunbookWorkerGroupGetResponse: HybridRunbookWorkerGroup & object

Contains response data for the get operation.

HybridRunbookWorkerGroupListByAutomationAccountNextResponse

HybridRunbookWorkerGroupListByAutomationAccountNextResponse: HybridRunbookWorkerGroupsListResult & object

Contains response data for the listByAutomationAccountNext operation.

HybridRunbookWorkerGroupListByAutomationAccountResponse

HybridRunbookWorkerGroupListByAutomationAccountResponse: HybridRunbookWorkerGroupsListResult & object

Contains response data for the listByAutomationAccount operation.

HybridRunbookWorkerGroupUpdateResponse

HybridRunbookWorkerGroupUpdateResponse: HybridRunbookWorkerGroup & object

Contains response data for the update operation.

JobCreateResponse

JobCreateResponse: Job & object

Contains response data for the create operation.

JobGetOutputResponse

JobGetOutputResponse: object

Contains response data for the getOutput operation.

Type declaration

JobGetResponse

JobGetResponse: Job & object

Contains response data for the get operation.

JobGetRunbookContentResponse

JobGetRunbookContentResponse: object

Contains response data for the getRunbookContent operation.

Type declaration

JobListByAutomationAccountNextResponse

JobListByAutomationAccountNextResponse: JobListResultV2 & object

Contains response data for the listByAutomationAccountNext operation.

JobListByAutomationAccountResponse

JobListByAutomationAccountResponse: JobListResultV2 & object

Contains response data for the listByAutomationAccount operation.

JobProvisioningState

JobProvisioningState: "Failed" | "Succeeded" | "Suspended" | "Processing"

Defines values for JobProvisioningState. Possible values include: 'Failed', 'Succeeded', 'Suspended', 'Processing'

readonly
enum

{string}

JobScheduleCreateResponse

JobScheduleCreateResponse: JobSchedule & object

Contains response data for the create operation.

JobScheduleGetResponse

JobScheduleGetResponse: JobSchedule & object

Contains response data for the get operation.

JobScheduleListByAutomationAccountNextResponse

JobScheduleListByAutomationAccountNextResponse: JobScheduleListResult & object

Contains response data for the listByAutomationAccountNext operation.

JobScheduleListByAutomationAccountResponse

JobScheduleListByAutomationAccountResponse: JobScheduleListResult & object

Contains response data for the listByAutomationAccount operation.

JobStatus

JobStatus: "New" | "Activating" | "Running" | "Completed" | "Failed" | "Stopped" | "Blocked" | "Suspended" | "Disconnected" | "Suspending" | "Stopping" | "Resuming" | "Removing"

Defines values for JobStatus. Possible values include: 'New', 'Activating', 'Running', 'Completed', 'Failed', 'Stopped', 'Blocked', 'Suspended', 'Disconnected', 'Suspending', 'Stopping', 'Resuming', 'Removing'

readonly
enum

{string}

JobStreamGetResponse

JobStreamGetResponse: JobStream & object

Contains response data for the get operation.

JobStreamListByJobNextResponse

JobStreamListByJobNextResponse: JobStreamListResult & object

Contains response data for the listByJobNext operation.

JobStreamListByJobResponse

JobStreamListByJobResponse: JobStreamListResult & object

Contains response data for the listByJob operation.

JobStreamType

JobStreamType: "Progress" | "Output" | "Warning" | "Error" | "Debug" | "Verbose" | "Any"

Defines values for JobStreamType. Possible values include: 'Progress', 'Output', 'Warning', 'Error', 'Debug', 'Verbose', 'Any'

readonly
enum

{string}

KeysListByAutomationAccountResponse

KeysListByAutomationAccountResponse: KeyListResult & object

Contains response data for the listByAutomationAccount operation.

LinkedWorkspaceGetResponse

LinkedWorkspaceGetResponse: LinkedWorkspace & object

Contains response data for the get operation.

LinuxUpdateClasses

LinuxUpdateClasses: "Unclassified" | "Critical" | "Security" | "Other"

Defines values for LinuxUpdateClasses. Possible values include: 'Unclassified', 'Critical', 'Security', 'Other'

readonly
enum

{string}

ModuleCreateOrUpdateResponse

ModuleCreateOrUpdateResponse: Module & object

Contains response data for the createOrUpdate operation.

ModuleGetResponse

ModuleGetResponse: Module & object

Contains response data for the get operation.

ModuleListByAutomationAccountNextResponse

ModuleListByAutomationAccountNextResponse: ModuleListResult & object

Contains response data for the listByAutomationAccountNext operation.

ModuleListByAutomationAccountResponse

ModuleListByAutomationAccountResponse: ModuleListResult & object

Contains response data for the listByAutomationAccount operation.

ModuleProvisioningState

ModuleProvisioningState: "Created" | "Creating" | "StartingImportModuleRunbook" | "RunningImportModuleRunbook" | "ContentRetrieved" | "ContentDownloaded" | "ContentValidated" | "ConnectionTypeImported" | "ContentStored" | "ModuleDataStored" | "ActivitiesStored" | "ModuleImportRunbookComplete" | "Succeeded" | "Failed" | "Cancelled" | "Updating"

Defines values for ModuleProvisioningState. Possible values include: 'Created', 'Creating', 'StartingImportModuleRunbook', 'RunningImportModuleRunbook', 'ContentRetrieved', 'ContentDownloaded', 'ContentValidated', 'ConnectionTypeImported', 'ContentStored', 'ModuleDataStored', 'ActivitiesStored', 'ModuleImportRunbookComplete', 'Succeeded', 'Failed', 'Cancelled', 'Updating'

readonly
enum

{string}

ModuleUpdateResponse

ModuleUpdateResponse: Module & object

Contains response data for the update operation.

NodeCountInformationGetResponse

NodeCountInformationGetResponse: NodeCounts & object

Contains response data for the get operation.

NodeReportsGetContentResponse

NodeReportsGetContentResponse: object

Contains response data for the getContent operation.

Type declaration

NodeReportsGetResponse

NodeReportsGetResponse: DscNodeReport & object

Contains response data for the get operation.

NodeReportsListByNodeNextResponse

NodeReportsListByNodeNextResponse: DscNodeReportListResult & object

Contains response data for the listByNodeNext operation.

NodeReportsListByNodeResponse

NodeReportsListByNodeResponse: DscNodeReportListResult & object

Contains response data for the listByNode operation.

ObjectDataTypesListFieldsByModuleAndTypeResponse

ObjectDataTypesListFieldsByModuleAndTypeResponse: TypeFieldListResult & object

Contains response data for the listFieldsByModuleAndType operation.

ObjectDataTypesListFieldsByTypeResponse

ObjectDataTypesListFieldsByTypeResponse: TypeFieldListResult & object

Contains response data for the listFieldsByType operation.

OperatingSystemType

OperatingSystemType: "Windows" | "Linux"

Defines values for OperatingSystemType. Possible values include: 'Windows', 'Linux'

readonly
enum

{string}

OperationsListResponse

OperationsListResponse: OperationListResult & object

Contains response data for the list operation.

ProvisioningState

ProvisioningState: "Completed" | "Failed" | "Running"

Defines values for ProvisioningState. Possible values include: 'Completed', 'Failed', 'Running'

readonly
enum

{string}

Python2PackageCreateOrUpdateResponse

Python2PackageCreateOrUpdateResponse: Module & object

Contains response data for the createOrUpdate operation.

Python2PackageGetResponse

Python2PackageGetResponse: Module & object

Contains response data for the get operation.

Python2PackageListByAutomationAccountNextResponse

Python2PackageListByAutomationAccountNextResponse: ModuleListResult & object

Contains response data for the listByAutomationAccountNext operation.

Python2PackageListByAutomationAccountResponse

Python2PackageListByAutomationAccountResponse: ModuleListResult & object

Contains response data for the listByAutomationAccount operation.

Python2PackageUpdateResponse

Python2PackageUpdateResponse: Module & object

Contains response data for the update operation.

RunbookCreateOrUpdateResponse

RunbookCreateOrUpdateResponse: Runbook & object

Contains response data for the createOrUpdate operation.

RunbookDraftGetContentResponse

RunbookDraftGetContentResponse: object

Contains response data for the getContent operation.

Type declaration

RunbookDraftGetResponse

RunbookDraftGetResponse: RunbookDraft & object

Contains response data for the get operation.

RunbookDraftReplaceContentResponse

RunbookDraftReplaceContentResponse: RunbookDraftReplaceContentHeaders & object

Contains response data for the replaceContent operation.

RunbookDraftUndoEditResponse

RunbookDraftUndoEditResponse: RunbookDraftUndoEditResult & object

Contains response data for the undoEdit operation.

RunbookGetContentResponse

RunbookGetContentResponse: object

Contains response data for the getContent operation.

Type declaration

RunbookGetResponse

RunbookGetResponse: Runbook & object

Contains response data for the get operation.

RunbookListByAutomationAccountNextResponse

RunbookListByAutomationAccountNextResponse: RunbookListResult & object

Contains response data for the listByAutomationAccountNext operation.

RunbookListByAutomationAccountResponse

RunbookListByAutomationAccountResponse: RunbookListResult & object

Contains response data for the listByAutomationAccount operation.

RunbookProvisioningState

RunbookProvisioningState: "Succeeded"

Defines values for RunbookProvisioningState. Possible values include: 'Succeeded'

readonly
enum

{string}

RunbookPublishResponse

RunbookPublishResponse: RunbookPublishHeaders & object

Contains response data for the publish operation.

RunbookState

RunbookState: "New" | "Edit" | "Published"

Defines values for RunbookState. Possible values include: 'New', 'Edit', 'Published'

readonly
enum

{string}

RunbookTypeEnum

RunbookTypeEnum: "Script" | "Graph" | "PowerShellWorkflow" | "PowerShell" | "GraphPowerShellWorkflow" | "GraphPowerShell"

Defines values for RunbookTypeEnum. Possible values include: 'Script', 'Graph', 'PowerShellWorkflow', 'PowerShell', 'GraphPowerShellWorkflow', 'GraphPowerShell'

readonly
enum

{string}

RunbookUpdateResponse

RunbookUpdateResponse: Runbook & object

Contains response data for the update operation.

ScheduleCreateOrUpdateResponse

ScheduleCreateOrUpdateResponse: Schedule & object

Contains response data for the createOrUpdate operation.

ScheduleDay

ScheduleDay: "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday"

Defines values for ScheduleDay. Possible values include: 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'

readonly
enum

{string}

ScheduleFrequency

ScheduleFrequency: "OneTime" | "Day" | "Hour" | "Week" | "Month"

Defines values for ScheduleFrequency. Possible values include: 'OneTime', 'Day', 'Hour', 'Week', 'Month'

readonly
enum

{string}

ScheduleGetResponse

ScheduleGetResponse: Schedule & object

Contains response data for the get operation.

ScheduleListByAutomationAccountNextResponse

ScheduleListByAutomationAccountNextResponse: ScheduleListResult & object

Contains response data for the listByAutomationAccountNext operation.

ScheduleListByAutomationAccountResponse

ScheduleListByAutomationAccountResponse: ScheduleListResult & object

Contains response data for the listByAutomationAccount operation.

ScheduleUpdateResponse

ScheduleUpdateResponse: Schedule & object

Contains response data for the update operation.

SkuNameEnum

SkuNameEnum: "Free" | "Basic"

Defines values for SkuNameEnum. Possible values include: 'Free', 'Basic'

readonly
enum

{string}

SoftwareUpdateConfigurationMachineRunsGetByIdResponse

SoftwareUpdateConfigurationMachineRunsGetByIdResponse: SoftwareUpdateConfigurationMachineRun & object

Contains response data for the getById operation.

SoftwareUpdateConfigurationMachineRunsListResponse

SoftwareUpdateConfigurationMachineRunsListResponse: SoftwareUpdateConfigurationMachineRunListResult & object

Contains response data for the list operation.

SoftwareUpdateConfigurationRunsGetByIdResponse

SoftwareUpdateConfigurationRunsGetByIdResponse: SoftwareUpdateConfigurationRun & object

Contains response data for the getById operation.

SoftwareUpdateConfigurationRunsListResponse

SoftwareUpdateConfigurationRunsListResponse: SoftwareUpdateConfigurationRunListResult & object

Contains response data for the list operation.

SoftwareUpdateConfigurationsCreateResponse

SoftwareUpdateConfigurationsCreateResponse: SoftwareUpdateConfiguration & object

Contains response data for the create operation.

SoftwareUpdateConfigurationsGetByNameResponse

SoftwareUpdateConfigurationsGetByNameResponse: SoftwareUpdateConfiguration & object

Contains response data for the getByName operation.

SoftwareUpdateConfigurationsListResponse

SoftwareUpdateConfigurationsListResponse: SoftwareUpdateConfigurationListResult & object

Contains response data for the list operation.

SourceControlCreateOrUpdateResponse

SourceControlCreateOrUpdateResponse: SourceControl & object

Contains response data for the createOrUpdate operation.

SourceControlGetResponse

SourceControlGetResponse: SourceControl & object

Contains response data for the get operation.

SourceControlListByAutomationAccountNextResponse

SourceControlListByAutomationAccountNextResponse: SourceControlListResult & object

Contains response data for the listByAutomationAccountNext operation.

SourceControlListByAutomationAccountResponse

SourceControlListByAutomationAccountResponse: SourceControlListResult & object

Contains response data for the listByAutomationAccount operation.

SourceControlSyncJobCreateResponse

SourceControlSyncJobCreateResponse: SourceControlSyncJob & object

Contains response data for the create operation.

SourceControlSyncJobGetResponse

SourceControlSyncJobGetResponse: SourceControlSyncJobById & object

Contains response data for the get operation.

SourceControlSyncJobListByAutomationAccountNextResponse

SourceControlSyncJobListByAutomationAccountNextResponse: SourceControlSyncJobListResult & object

Contains response data for the listByAutomationAccountNext operation.

SourceControlSyncJobListByAutomationAccountResponse

SourceControlSyncJobListByAutomationAccountResponse: SourceControlSyncJobListResult & object

Contains response data for the listByAutomationAccount operation.

SourceControlSyncJobStreamsGetResponse

SourceControlSyncJobStreamsGetResponse: SourceControlSyncJobStreamById & object

Contains response data for the get operation.

SourceControlSyncJobStreamsListBySyncJobNextResponse

SourceControlSyncJobStreamsListBySyncJobNextResponse: SourceControlSyncJobStreamsListBySyncJob & object

Contains response data for the listBySyncJobNext operation.

SourceControlSyncJobStreamsListBySyncJobResponse

SourceControlSyncJobStreamsListBySyncJobResponse: SourceControlSyncJobStreamsListBySyncJob & object

Contains response data for the listBySyncJob operation.

SourceControlUpdateResponse

SourceControlUpdateResponse: SourceControl & object

Contains response data for the update operation.

SourceType

SourceType: "VsoGit" | "VsoTfvc" | "GitHub"

Defines values for SourceType. Possible values include: 'VsoGit', 'VsoTfvc', 'GitHub'

readonly
enum

{string}

StatisticsListByAutomationAccountResponse

StatisticsListByAutomationAccountResponse: StatisticsListResult & object

Contains response data for the listByAutomationAccount operation.

StreamType

StreamType: "Error" | "Output"

Defines values for StreamType. Possible values include: 'Error', 'Output'

readonly
enum

{string}

SyncType

SyncType: "PartialSync" | "FullSync"

Defines values for SyncType. Possible values include: 'PartialSync', 'FullSync'

readonly
enum

{string}

TagOperators

TagOperators: "All" | "Any"

Defines values for TagOperators. Possible values include: 'All', 'Any'

readonly
enum

{string}

TestJobCreateResponse

TestJobCreateResponse: TestJob & object

Contains response data for the create operation.

TestJobGetResponse

TestJobGetResponse: TestJob & object

Contains response data for the get operation.

TestJobStreamsGetResponse

TestJobStreamsGetResponse: JobStream & object

Contains response data for the get operation.

TestJobStreamsListByTestJobNextResponse

TestJobStreamsListByTestJobNextResponse: JobStreamListResult & object

Contains response data for the listByTestJobNext operation.

TestJobStreamsListByTestJobResponse

TestJobStreamsListByTestJobResponse: JobStreamListResult & object

Contains response data for the listByTestJob operation.

TokenType

TokenType: "PersonalAccessToken" | "Oauth"

Defines values for TokenType. Possible values include: 'PersonalAccessToken', 'Oauth'

readonly
enum

{string}

UsagesListByAutomationAccountResponse

UsagesListByAutomationAccountResponse: UsageListResult & object

Contains response data for the listByAutomationAccount operation.

VariableCreateOrUpdateResponse

VariableCreateOrUpdateResponse: Variable & object

Contains response data for the createOrUpdate operation.

VariableGetResponse

VariableGetResponse: Variable & object

Contains response data for the get operation.

VariableListByAutomationAccountNextResponse

VariableListByAutomationAccountNextResponse: VariableListResult & object

Contains response data for the listByAutomationAccountNext operation.

VariableListByAutomationAccountResponse

VariableListByAutomationAccountResponse: VariableListResult & object

Contains response data for the listByAutomationAccount operation.

VariableUpdateResponse

VariableUpdateResponse: Variable & object

Contains response data for the update operation.

WatcherCreateOrUpdateResponse

WatcherCreateOrUpdateResponse: Watcher & object

Contains response data for the createOrUpdate operation.

WatcherGetResponse

WatcherGetResponse: Watcher & object

Contains response data for the get operation.

WatcherListByAutomationAccountNextResponse

WatcherListByAutomationAccountNextResponse: WatcherListResult & object

Contains response data for the listByAutomationAccountNext operation.

WatcherListByAutomationAccountResponse

WatcherListByAutomationAccountResponse: WatcherListResult & object

Contains response data for the listByAutomationAccount operation.

WatcherUpdateResponse

WatcherUpdateResponse: Watcher & object

Contains response data for the update operation.

WebhookCreateOrUpdateResponse

WebhookCreateOrUpdateResponse: Webhook & object

Contains response data for the createOrUpdate operation.

WebhookGenerateUriResponse

WebhookGenerateUriResponse: object

Contains response data for the generateUri operation.

Type declaration

WebhookGetResponse

WebhookGetResponse: Webhook & object

Contains response data for the get operation.

WebhookListByAutomationAccountNextResponse

WebhookListByAutomationAccountNextResponse: WebhookListResult & object

Contains response data for the listByAutomationAccountNext operation.

WebhookListByAutomationAccountResponse

WebhookListByAutomationAccountResponse: WebhookListResult & object

Contains response data for the listByAutomationAccount operation.

WebhookUpdateResponse

WebhookUpdateResponse: Webhook & object

Contains response data for the update operation.

WindowsUpdateClasses

WindowsUpdateClasses: "Unclassified" | "Critical" | "Security" | "UpdateRollup" | "FeaturePack" | "ServicePack" | "Definition" | "Tools" | "Updates"

Defines values for WindowsUpdateClasses. Possible values include: 'Unclassified', 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', 'Updates'

readonly
enum

{string}

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const Activity

Activity: object
interface

An interface representing Activity. Definition of the activity.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time.

Optional definition

definition: undefined | string
member

{string} [definition] Gets or sets the user name of the activity.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional id

id: undefined | string
member

{string} [id] Gets or sets the id of the resource.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time.

Optional name

name: undefined | string
member

{string} [name] Gets the name of the activity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputTypes

outputTypes: ActivityOutputType[]
member

{ActivityOutputType[]} [outputTypes] Gets or sets the output types of the activity.

Optional parameterSets

parameterSets: ActivityParameterSet[]
member

{ActivityParameterSet[]} [parameterSets] Gets or sets the parameter sets of the activity.

serializedName

serializedName: string = "Activity"

type

type: object

className

className: string = "Activity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

definition

definition: object

serializedName

serializedName: string = "properties.definition"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

outputTypes

outputTypes: object

serializedName

serializedName: string = "properties.outputTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ActivityOutputType"

name

name: "Composite" = "Composite"

parameterSets

parameterSets: object

serializedName

serializedName: string = "properties.parameterSets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ActivityParameterSet"

name

name: "Composite" = "Composite"

Const ActivityListResult

ActivityListResult: object
interface

An interface representing the ActivityListResult. The response model for the list activity operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "ActivityListResult"

__@iterator

  • __@iterator(): IterableIterator<Activity>
  • Iterator

    Returns IterableIterator<Activity>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Activity>[]

      Additional items to add to the end of array1.

    Returns Activity[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Activity[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Activity]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Activity]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Activity, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Activity

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Activity[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Activity[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Activity | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Activity | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Activity, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Activity

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Activity, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Activity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Activity, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Activity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Activity | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Activity[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Activity
  • reduce(callbackfn: function, initialValue: Activity): Activity
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Activity

  • Parameters

    Returns Activity

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Activity, currentIndex: number, array: Activity[]): U
        • Parameters

          • previousValue: U
          • currentValue: Activity
          • currentIndex: number
          • array: Activity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Activity
  • reduceRight(callbackfn: function, initialValue: Activity): Activity
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Activity

  • Parameters

    Returns Activity

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Activity, currentIndex: number, array: Activity[]): U
        • Parameters

          • previousValue: U
          • currentValue: Activity
          • currentIndex: number
          • array: Activity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Activity[]

shift

  • Removes the first element from an array and returns it.

    Returns Activity | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Activity[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Activity[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Activity[]
  • splice(start: number, deleteCount: number, ...items: Activity[]): Activity[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Activity[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Activity[]

      Elements to insert into the array in place of the deleted elements.

    Returns Activity[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Activity[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Activity>

type

type: object

className

className: string = "ActivityListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Activity"

name

name: "Composite" = "Composite"

Const ActivityOutputType

ActivityOutputType: object
interface

An interface representing ActivityOutputType. Definition of the activity output type.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the activity output type.

serializedName

serializedName: string = "ActivityOutputType"

Optional type

type: object
member

{string} [type] Gets or sets the type of the activity output type.

className

className: string = "ActivityOutputType"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ActivityParameter

ActivityParameter: object
interface

An interface representing ActivityParameter. Definition of the activity parameter.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the activity parameter.

Optional isDynamic

isDynamic: undefined | false | true
member

{boolean} [isDynamic] Gets or sets a Boolean value that indicates true if the parameter is dynamic.

Optional isMandatory

isMandatory: undefined | false | true
member

{boolean} [isMandatory] Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the activity parameter.

Optional position

position: undefined | number
member

{number} [position] Gets or sets the position of the activity parameter.

Optional validationSet

member

{ActivityParameterValidationSet[]} [validationSet] Gets or sets the validation set of activity parameter.

Optional valueFromPipeline

valueFromPipeline: undefined | false | true
member

{boolean} [valueFromPipeline] Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object.

Optional valueFromPipelineByPropertyName

valueFromPipelineByPropertyName: undefined | false | true
member

{boolean} [valueFromPipelineByPropertyName] Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name.

Optional valueFromRemainingArguments

valueFromRemainingArguments: undefined | false | true
member

{boolean} [valueFromRemainingArguments] Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.

serializedName

serializedName: string = "ActivityParameter"

Optional type

type: object
member

{string} [type] Gets or sets the type of the activity parameter.

className

className: string = "ActivityParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

isDynamic

isDynamic: object

serializedName

serializedName: string = "isDynamic"

type

type: object

name

name: "Boolean" = "Boolean"

isMandatory

isMandatory: object

serializedName

serializedName: string = "isMandatory"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

position

position: object

serializedName

serializedName: string = "position"

type

type: object

name

name: "Number" = "Number"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

validationSet

validationSet: object

serializedName

serializedName: string = "validationSet"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ActivityParameterValidationSet"

name

name: "Composite" = "Composite"

valueFromPipeline

valueFromPipeline: object

serializedName

serializedName: string = "valueFromPipeline"

type

type: object

name

name: "Boolean" = "Boolean"

valueFromPipelineByPropertyName

valueFromPipelineByPropertyName: object

serializedName

serializedName: string = "valueFromPipelineByPropertyName"

type

type: object

name

name: "Boolean" = "Boolean"

valueFromRemainingArguments

valueFromRemainingArguments: object

serializedName

serializedName: string = "valueFromRemainingArguments"

type

type: object

name

name: "Boolean" = "Boolean"

Const ActivityParameterSet

ActivityParameterSet: object
interface

An interface representing ActivityParameterSet. Definition of the activity parameter set.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the activity parameter set.

Optional parameters

parameters: ActivityParameter[]
member

{ActivityParameter[]} [parameters] Gets or sets the parameters of the activity parameter set.

serializedName

serializedName: string = "ActivityParameterSet"

type

type: object

className

className: string = "ActivityParameterSet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ActivityParameter"

name

name: "Composite" = "Composite"

Const ActivityParameterValidationSet

ActivityParameterValidationSet: object
interface

An interface representing ActivityParameterValidationSet. Definition of the activity parameter validation set.

Optional memberValue

memberValue: undefined | string
member

{string} [memberValue] Gets or sets the name of the activity parameter validation set member.

serializedName

serializedName: string = "ActivityParameterValidationSet"

type

type: object

className

className: string = "ActivityParameterValidationSet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

memberValue

memberValue: object

serializedName

serializedName: string = "memberValue"

type

type: object

name

name: "String" = "String"

Const AdvancedSchedule

AdvancedSchedule: object
interface

An interface representing AdvancedSchedule. The properties of the create Advanced Schedule.

Optional monthDays

monthDays: number[]
member

{number[]} [monthDays] Days of the month that the job should execute on. Must be between 1 and 31.

Optional monthlyOccurrences

monthlyOccurrences: AdvancedScheduleMonthlyOccurrence[]
member

{AdvancedScheduleMonthlyOccurrence[]} [monthlyOccurrences] Occurrences of days within a month.

Optional weekDays

weekDays: string[]
member

{string[]} [weekDays] Days of the week that the job should execute on.

serializedName

serializedName: string = "AdvancedSchedule"

type

type: object

className

className: string = "AdvancedSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

monthDays

monthDays: object

serializedName

serializedName: string = "monthDays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

monthlyOccurrences

monthlyOccurrences: object

serializedName

serializedName: string = "monthlyOccurrences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AdvancedScheduleMonthlyOccurrence"

name

name: "Composite" = "Composite"

weekDays

weekDays: object

serializedName

serializedName: string = "weekDays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AdvancedScheduleMonthlyOccurrence

AdvancedScheduleMonthlyOccurrence: object
interface

An interface representing AdvancedScheduleMonthlyOccurrence. The properties of the create advanced schedule monthly occurrence.

Optional day

member

{ScheduleDay} [day] Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. Possible values include: 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'

Optional occurrence

occurrence: undefined | number
member

{number} [occurrence] Occurrence of the week within the month. Must be between 1 and 5

serializedName

serializedName: string = "AdvancedScheduleMonthlyOccurrence"

type

type: object

className

className: string = "AdvancedScheduleMonthlyOccurrence"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

day

day: object

serializedName

serializedName: string = "day"

type

type: object

name

name: "String" = "String"

occurrence

occurrence: object

serializedName

serializedName: string = "occurrence"

type

type: object

name

name: "Number" = "Number"

Const AgentRegistration

AgentRegistration: object
interface

An interface representing AgentRegistration. Definition of the agent registration infomration type.

Optional dscMetaConfiguration

dscMetaConfiguration: undefined | string
member

{string} [dscMetaConfiguration] Gets or sets the dsc meta configuration.

Optional endpoint

endpoint: undefined | string
member

{string} [endpoint] Gets or sets the dsc server endpoint.

Optional id

id: undefined | string
member

{string} [id] Gets or sets the id.

Optional keys

member

{AgentRegistrationKeys} [keys] Gets or sets the agent registration keys.

serializedName

serializedName: string = "AgentRegistration"

type

type: object

className

className: string = "AgentRegistration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dscMetaConfiguration

dscMetaConfiguration: object

serializedName

serializedName: string = "dscMetaConfiguration"

type

type: object

name

name: "String" = "String"

endpoint

endpoint: object

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

keys

keys: object

serializedName

serializedName: string = "keys"

type

type: object

className

className: string = "AgentRegistrationKeys"

name

name: "Composite" = "Composite"

Const AgentRegistrationKeys

AgentRegistrationKeys: object
interface

An interface representing AgentRegistrationKeys. Definition of the agent registration keys.

Optional primary

primary: undefined | string
member

{string} [primary] Gets or sets the primary key.

Optional secondary

secondary: undefined | string
member

{string} [secondary] Gets or sets the secondary key.

serializedName

serializedName: string = "AgentRegistrationKeys"

type

type: object

className

className: string = "AgentRegistrationKeys"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

primary

primary: object

serializedName

serializedName: string = "primary"

type

type: object

name

name: "String" = "String"

secondary

secondary: object

serializedName

serializedName: string = "secondary"

type

type: object

name

name: "String" = "String"

Const AgentRegistrationRegenerateKeyParameter

AgentRegistrationRegenerateKeyParameter: object
interface

An interface representing AgentRegistrationRegenerateKeyParameter. The parameters supplied to the regenerate keys operation.

keyName

member

{AgentRegistrationKeyName} keyName Gets or sets the agent registration key name - primary or secondary. Possible values include: 'primary', 'secondary'

serializedName

serializedName: string = "AgentRegistrationRegenerateKeyParameter"

type

type: object

className

className: string = "AgentRegistrationRegenerateKeyParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyName

keyName: object

required

required: true = true

serializedName

serializedName: string = "keyName"

type

type: object

name

name: "String" = "String"

Const AutomationAccount

AutomationAccount: object
interface

An interface representing AutomationAccount. Definition of the automation account type.

extends

TrackedResource

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets the creation time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional etag

etag: undefined | string
member

{string} [etag] Gets or sets the etag of the resource.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedBy

lastModifiedBy: undefined | string
member

{string} [lastModifiedBy] Gets or sets the last modified by.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets the last modified time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] The Azure Region where the resource lives

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional sku

sku: Sku
member

{Sku} [sku] Gets or sets the SKU of account.

Optional state

member

{AutomationAccountState} [state] Gets status of account. Possible values include: 'Ok', 'Unavailable', 'Suspended' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

serializedName

serializedName: string = "AutomationAccount"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "AutomationAccount"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModifiedBy

lastModifiedBy: object

serializedName

serializedName: string = "properties.lastModifiedBy"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const AutomationAccountCreateOrUpdateParameters

AutomationAccountCreateOrUpdateParameters: object
interface

An interface representing AutomationAccountCreateOrUpdateParameters. The parameters supplied to the create or update automation account operation.

Optional location

location: undefined | string
member

{string} [location] Gets or sets the location of the resource.

Optional name

name: undefined | string
member

{string} [name] Gets or sets name of the resource.

Optional sku

sku: Sku
member

{Sku} [sku] Gets or sets account SKU.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "AutomationAccountCreateOrUpdateParameters"

type

type: object

className

className: string = "AutomationAccountCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const AutomationAccountListResult

AutomationAccountListResult: object
interface

An interface representing the AutomationAccountListResult. The response model for the list account operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "AutomationAccountListResult"

__@iterator

  • Iterator

    Returns IterableIterator<AutomationAccount>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AutomationAccount>[]

      Additional items to add to the end of array1.

    Returns AutomationAccount[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AutomationAccount[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AutomationAccount]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AutomationAccount, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AutomationAccount

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AutomationAccount[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AutomationAccount[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AutomationAccount | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns AutomationAccount | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AutomationAccount, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AutomationAccount

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AutomationAccount

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AutomationAccount, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AutomationAccount

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns AutomationAccount | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns AutomationAccount

  • Parameters

    Returns AutomationAccount

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns AutomationAccount

  • Parameters

    Returns AutomationAccount

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns AutomationAccount[]

shift

  • Removes the first element from an array and returns it.

    Returns AutomationAccount | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AutomationAccount[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AutomationAccount[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AutomationAccount[]

      Elements to insert into the array in place of the deleted elements.

    Returns AutomationAccount[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<AutomationAccount>

type

type: object

className

className: string = "AutomationAccountListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AutomationAccount"

name

name: "Composite" = "Composite"

Const AutomationAccountUpdateParameters

AutomationAccountUpdateParameters: object
interface

An interface representing AutomationAccountUpdateParameters. The parameters supplied to the update automation account operation.

Optional location

location: undefined | string
member

{string} [location] Gets or sets the location of the resource.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the resource.

Optional sku

sku: Sku
member

{Sku} [sku] Gets or sets account SKU.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "AutomationAccountUpdateParameters"

type

type: object

className

className: string = "AutomationAccountUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const AzureQueryProperties

AzureQueryProperties: object
interface

An interface representing AzureQueryProperties. Azure query for the update configuration.

Optional locations

locations: string[]
member

{string[]} [locations] List of locations to scope the query to.

Optional scope

scope: string[]
member

{string[]} [scope] List of Subscription or Resource Group ARM Ids.

Optional tagSettings

member

{TagSettingsProperties} [tagSettings] Tag settings for the VM.

serializedName

serializedName: string = "AzureQueryProperties"

type

type: object

className

className: string = "AzureQueryProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

locations

locations: object

serializedName

serializedName: string = "locations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

scope

scope: object

serializedName

serializedName: string = "scope"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

tagSettings

tagSettings: object

serializedName

serializedName: string = "tagSettings"

type

type: object

className

className: string = "TagSettingsProperties"

name

name: "Composite" = "Composite"

Const Certificate

Certificate: object
interface

An interface representing Certificate. Definition of the certificate.

extends

ProxyResource

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets the creation time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional expiryTime

expiryTime: Date
member

{Date} [expiryTime] Gets the expiry time of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional isExportable

isExportable: undefined | false | true
member

{boolean} [isExportable] Gets the is exportable flag of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets the last modified time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional thumbprint

thumbprint: undefined | string
member

{string} [thumbprint] Gets the thumbprint of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Certificate"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Certificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

expiryTime

expiryTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

isExportable

isExportable: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isExportable"

type

type: object

name

name: "Boolean" = "Boolean"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

thumbprint

thumbprint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

Const CertificateCreateOrUpdateParameters

CertificateCreateOrUpdateParameters: object
interface

An interface representing CertificateCreateOrUpdateParameters. The parameters supplied to the create or update or replace certificate operation.

base64Value

base64Value: string
member

{string} base64Value Gets or sets the base64 encoded value of the certificate.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the certificate.

Optional isExportable

isExportable: undefined | false | true
member

{boolean} [isExportable] Gets or sets the is exportable flag of the certificate.

name

name: string
member

{string} name Gets or sets the name of the certificate.

Optional thumbprint

thumbprint: undefined | string
member

{string} [thumbprint] Gets or sets the thumbprint of the certificate.

serializedName

serializedName: string = "CertificateCreateOrUpdateParameters"

type

type: object

className

className: string = "CertificateCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

base64Value

base64Value: object

required

required: true = true

serializedName

serializedName: string = "properties.base64Value"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isExportable

isExportable: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.isExportable"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

Const CertificateListResult

CertificateListResult: object
interface

An interface representing the CertificateListResult. The response model for the list certificate operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "CertificateListResult"

__@iterator

  • Iterator

    Returns IterableIterator<Certificate>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Certificate>[]

      Additional items to add to the end of array1.

    Returns Certificate[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Certificate[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Certificate]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Certificate, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Certificate

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Certificate[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Certificate[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Certificate | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Certificate | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Certificate, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Certificate

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Certificate, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Certificate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Certificate, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Certificate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Certificate | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Certificate[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Certificate

  • Parameters

    Returns Certificate

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Certificate
  • reduceRight(callbackfn: function, initialValue: Certificate): Certificate
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Certificate

  • Parameters

    Returns Certificate

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Certificate[]

shift

  • Removes the first element from an array and returns it.

    Returns Certificate | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Certificate[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Certificate[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Certificate[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Certificate[]

      Elements to insert into the array in place of the deleted elements.

    Returns Certificate[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Certificate[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Certificate>

type

type: object

className

className: string = "CertificateListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Certificate"

name

name: "Composite" = "Composite"

Const CertificateUpdateParameters

CertificateUpdateParameters: object
interface

An interface representing CertificateUpdateParameters. The parameters supplied to the update certificate operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the certificate.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the certificate.

serializedName

serializedName: string = "CertificateUpdateParameters"

type

type: object

className

className: string = "CertificateUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const CollectionItemUpdateConfiguration

CollectionItemUpdateConfiguration: object
interface

An interface representing CollectionItemUpdateConfiguration. object returned when requesting a collection of software update configuration

Optional azureVirtualMachines

azureVirtualMachines: string[]
member

{string[]} [azureVirtualMachines] List of azure resource Ids for azure virtual machines targeted by the software update configuration.

Optional duration

duration: undefined | string
member

{string} [duration] Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601

serializedName

serializedName: string = "collectionItemUpdateConfiguration"

type

type: object

className

className: string = "CollectionItemUpdateConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureVirtualMachines

azureVirtualMachines: object

serializedName

serializedName: string = "azureVirtualMachines"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

duration

duration: object

serializedName

serializedName: string = "duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const Connection

Connection: object
interface

An interface representing Connection. Definition of the connection.

extends

ProxyResource

Optional connectionType

member

{ConnectionTypeAssociationProperty} [connectionType] Gets or sets the connectionType of the connection.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets the creation time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional fieldDefinitionValues

fieldDefinitionValues: undefined | object
member

{{ [propertyName: string]: string }} [fieldDefinitionValues] Gets the field definition values of the connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets the last modified time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Connection"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Connection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionType

connectionType: object

serializedName

serializedName: string = "properties.connectionType"

type

type: object

className

className: string = "ConnectionTypeAssociationProperty"

name

name: "Composite" = "Composite"

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

fieldDefinitionValues

fieldDefinitionValues: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.fieldDefinitionValues"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const ConnectionCreateOrUpdateParameters

ConnectionCreateOrUpdateParameters: object
interface

An interface representing ConnectionCreateOrUpdateParameters. The parameters supplied to the create or update connection operation.

connectionType

member

{ConnectionTypeAssociationProperty} connectionType Gets or sets the connectionType of the connection.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the connection.

Optional fieldDefinitionValues

fieldDefinitionValues: undefined | object
member

{{ [propertyName: string]: string }} [fieldDefinitionValues] Gets or sets the field definition properties of the connection.

name

name: string
member

{string} name Gets or sets the name of the connection.

serializedName

serializedName: string = "ConnectionCreateOrUpdateParameters"

type

type: object

className

className: string = "ConnectionCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionType

connectionType: object

required

required: true = true

serializedName

serializedName: string = "properties.connectionType"

type

type: object

className

className: string = "ConnectionTypeAssociationProperty"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

fieldDefinitionValues

fieldDefinitionValues: object

serializedName

serializedName: string = "properties.fieldDefinitionValues"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ConnectionListResult

ConnectionListResult: object
interface

An interface representing the ConnectionListResult. The response model for the list connection operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "ConnectionListResult"

__@iterator

  • Iterator

    Returns IterableIterator<Connection>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Connection>[]

      Additional items to add to the end of array1.

    Returns Connection[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Connection[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Connection]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Connection]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Connection, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Connection

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Connection[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Connection[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Connection | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Connection | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Connection, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Connection

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Connection, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Connection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Connection, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Connection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Connection | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Connection[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Connection
  • reduce(callbackfn: function, initialValue: Connection): Connection
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Connection

  • Parameters

    Returns Connection

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Connection
  • reduceRight(callbackfn: function, initialValue: Connection): Connection
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Connection

  • Parameters

    Returns Connection

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Connection[]

shift

  • Removes the first element from an array and returns it.

    Returns Connection | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Connection[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Connection[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Connection[]
  • splice(start: number, deleteCount: number, ...items: Connection[]): Connection[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Connection[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Connection[]

      Elements to insert into the array in place of the deleted elements.

    Returns Connection[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Connection[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Connection>

type

type: object

className

className: string = "ConnectionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Connection"

name

name: "Composite" = "Composite"

Const ConnectionType

ConnectionType: object
interface

An interface representing ConnectionType. Definition of the connection type.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets the creation time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional fieldDefinitions

fieldDefinitions: undefined | object
member

{{ [propertyName: string]: FieldDefinition }} [fieldDefinitions] Gets the field definitions of the connection type. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] Gets the id of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isGlobal

isGlobal: undefined | false | true
member

{boolean} [isGlobal] Gets or sets a Boolean value to indicate if the connection type is global.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time.

Optional name

name: undefined | string
member

{string} [name] Gets the name of the connection type. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ConnectionType"

Optional type

type: object
member

{string} [type] Resource type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ConnectionType"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

fieldDefinitions

fieldDefinitions: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.fieldDefinitions"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "FieldDefinition"

name

name: "Composite" = "Composite"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

isGlobal

isGlobal: object

serializedName

serializedName: string = "properties.isGlobal"

type

type: object

name

name: "Boolean" = "Boolean"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ConnectionTypeAssociationProperty

ConnectionTypeAssociationProperty: object
interface

An interface representing ConnectionTypeAssociationProperty. The connection type property associated with the entity.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the connection type.

serializedName

serializedName: string = "ConnectionTypeAssociationProperty"

type

type: object

className

className: string = "ConnectionTypeAssociationProperty"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ConnectionTypeCreateOrUpdateParameters

ConnectionTypeCreateOrUpdateParameters: object
interface

An interface representing ConnectionTypeCreateOrUpdateParameters. The parameters supplied to the create or update connection type operation.

fieldDefinitions

fieldDefinitions: object
member

{{ [propertyName: string]: FieldDefinition }} fieldDefinitions Gets or sets the field definitions of the connection type.

Type declaration

Optional isGlobal

isGlobal: undefined | false | true
member

{boolean} [isGlobal] Gets or sets a Boolean value to indicate if the connection type is global.

name

name: string
member

{string} name Gets or sets the name of the connection type.

serializedName

serializedName: string = "ConnectionTypeCreateOrUpdateParameters"

type

type: object

className

className: string = "ConnectionTypeCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fieldDefinitions

fieldDefinitions: object

required

required: true = true

serializedName

serializedName: string = "properties.fieldDefinitions"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "FieldDefinition"

name

name: "Composite" = "Composite"

isGlobal

isGlobal: object

serializedName

serializedName: string = "properties.isGlobal"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ConnectionTypeListResult

ConnectionTypeListResult: object
interface

An interface representing the ConnectionTypeListResult. The response model for the list connection type operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "ConnectionTypeListResult"

__@iterator

  • Iterator

    Returns IterableIterator<ConnectionType>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ConnectionType>[]

      Additional items to add to the end of array1.

    Returns ConnectionType[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ConnectionType[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ConnectionType]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ConnectionType, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ConnectionType

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ConnectionType[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ConnectionType[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ConnectionType | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ConnectionType | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ConnectionType, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ConnectionType

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ConnectionType, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ConnectionType

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ConnectionType, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ConnectionType

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ConnectionType | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ConnectionType

  • Parameters

    Returns ConnectionType

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ConnectionType

  • Parameters

    Returns ConnectionType

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ConnectionType[]

shift

  • Removes the first element from an array and returns it.

    Returns ConnectionType | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ConnectionType[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ConnectionType[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ConnectionType[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ConnectionType[]

      Elements to insert into the array in place of the deleted elements.

    Returns ConnectionType[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ConnectionType[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ConnectionType>

type

type: object

className

className: string = "ConnectionTypeListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnectionType"

name

name: "Composite" = "Composite"

Const ConnectionUpdateParameters

ConnectionUpdateParameters: object
interface

An interface representing ConnectionUpdateParameters. The parameters supplied to the update connection operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the connection.

Optional fieldDefinitionValues

fieldDefinitionValues: undefined | object
member

{{ [propertyName: string]: string }} [fieldDefinitionValues] Gets or sets the field definition values of the connection.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the connection.

serializedName

serializedName: string = "ConnectionUpdateParameters"

type

type: object

className

className: string = "ConnectionUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

fieldDefinitionValues

fieldDefinitionValues: object

serializedName

serializedName: string = "properties.fieldDefinitionValues"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ContentHash

ContentHash: object
interface

An interface representing ContentHash. Definition of the runbook property type.

algorithm

algorithm: string
member

{string} algorithm Gets or sets the content hash algorithm used to hash the content.

value

value: string
member

{string} value Gets or sets expected hash value of the content.

serializedName

serializedName: string = "ContentHash"

type

type: object

className

className: string = "ContentHash"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

algorithm

algorithm: object

required

required: true = true

serializedName

serializedName: string = "algorithm"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ContentLink

ContentLink: object
interface

An interface representing ContentLink. Definition of the content link.

Optional contentHash

contentHash: ContentHash
member

{ContentHash} [contentHash] Gets or sets the hash.

Optional uri

uri: undefined | string
member

{string} [uri] Gets or sets the uri of the runbook content.

Optional version

version: undefined | string
member

{string} [version] Gets or sets the version of the content.

serializedName

serializedName: string = "ContentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentHash

contentHash: object

serializedName

serializedName: string = "contentHash"

type

type: object

className

className: string = "ContentHash"

name

name: "Composite" = "Composite"

uri

uri: object

serializedName

serializedName: string = "uri"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const ContentSource

ContentSource: object
interface

An interface representing ContentSource. Definition of the content source.

Optional hash

member

{ContentHash} [hash] Gets or sets the hash.

Optional value

value: undefined | string
member

{string} [value] Gets or sets the value of the content. This is based on the content source type.

Optional version

version: undefined | string
member

{string} [version] Gets or sets the version of the content.

serializedName

serializedName: string = "ContentSource"

Optional type

type: object
member

{ContentSourceType} [type] Gets or sets the content source type. Possible values include: 'embeddedContent', 'uri'

className

className: string = "ContentSource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hash

hash: object

serializedName

serializedName: string = "hash"

type

type: object

className

className: string = "ContentHash"

name

name: "Composite" = "Composite"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const Credential

Credential: object
interface

An interface representing Credential. Definition of the credential.

extends

ProxyResource

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets the creation time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets the last modified time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional userName

userName: undefined | string
member

{string} [userName] Gets the user name of the credential. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Credential"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Credential"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

userName

userName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.userName"

type

type: object

name

name: "String" = "String"

Const CredentialCreateOrUpdateParameters

CredentialCreateOrUpdateParameters: object
interface

An interface representing CredentialCreateOrUpdateParameters. The parameters supplied to the create or update credential operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the credential.

name

name: string
member

{string} name Gets or sets the name of the credential.

password

password: string
member

{string} password Gets or sets the password of the credential.

userName

userName: string
member

{string} userName Gets or sets the user name of the credential.

serializedName

serializedName: string = "CredentialCreateOrUpdateParameters"

type

type: object

className

className: string = "CredentialCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

password

password: object

required

required: true = true

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

userName

userName: object

required

required: true = true

serializedName

serializedName: string = "properties.userName"

type

type: object

name

name: "String" = "String"

Const CredentialListResult

CredentialListResult: object
interface

An interface representing the CredentialListResult. The response model for the list credential operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "CredentialListResult"

__@iterator

  • Iterator

    Returns IterableIterator<Credential>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Credential>[]

      Additional items to add to the end of array1.

    Returns Credential[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Credential[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Credential]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Credential]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Credential, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Credential

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Credential[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Credential[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Credential | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Credential | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Credential, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Credential

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Credential, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Credential

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Credential, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Credential

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Credential | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Credential[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Credential
  • reduce(callbackfn: function, initialValue: Credential): Credential
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Credential

  • Parameters

    Returns Credential

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Credential
  • reduceRight(callbackfn: function, initialValue: Credential): Credential
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Credential

  • Parameters

    Returns Credential

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Credential[]

shift

  • Removes the first element from an array and returns it.

    Returns Credential | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Credential[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Credential[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Credential[]
  • splice(start: number, deleteCount: number, ...items: Credential[]): Credential[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Credential[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Credential[]

      Elements to insert into the array in place of the deleted elements.

    Returns Credential[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Credential[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Credential>

type

type: object

className

className: string = "CredentialListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Credential"

name

name: "Composite" = "Composite"

Const CredentialUpdateParameters

CredentialUpdateParameters: object
interface

An interface representing CredentialUpdateParameters. The parameters supplied to the Update credential operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the credential.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the credential.

Optional password

password: undefined | string
member

{string} [password] Gets or sets the password of the credential.

Optional userName

userName: undefined | string
member

{string} [userName] Gets or sets the user name of the credential.

serializedName

serializedName: string = "CredentialUpdateParameters"

type

type: object

className

className: string = "CredentialUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

userName

userName: object

serializedName

serializedName: string = "properties.userName"

type

type: object

name

name: "String" = "String"

Const DscCompilationJob

DscCompilationJob: object
interface

An interface representing DscCompilationJob. Definition of the Dsc Compilation job.

extends

ProxyResource

Optional configuration

member

{DscConfigurationAssociationProperty} [configuration] Gets or sets the configuration.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets the creation time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date
member

{Date} [endTime] Gets the end time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional exception

exception: undefined | string
member

{string} [exception] Gets the exception of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobId

jobId: undefined | string
member

{string} [jobId] Gets the id of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets the last modified time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastStatusModifiedTime

lastStatusModifiedTime: Date
member

{Date} [lastStatusModifiedTime] Gets the last status modified time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the job.

Optional provisioningState

provisioningState: JobProvisioningState
member

{JobProvisioningState} [provisioningState] The current provisioning state of the job. Possible values include: 'Failed', 'Succeeded', 'Suspended', 'Processing'

Optional runOn

runOn: undefined | string
member

{string} [runOn] Gets or sets the runOn which specifies the group name where the job is to be executed.

Optional startTime

startTime: Date
member

{Date} [startTime] Gets the start time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startedBy

startedBy: undefined | string
member

{string} [startedBy] Gets the compilation job started by. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: JobStatus
member

{JobStatus} [status] Gets or sets the status of the job. Possible values include: 'New', 'Activating', 'Running', 'Completed', 'Failed', 'Stopped', 'Blocked', 'Suspended', 'Disconnected', 'Suspending', 'Stopping', 'Resuming', 'Removing'

Optional statusDetails

statusDetails: undefined | string
member

{string} [statusDetails] Gets or sets the status details of the job.

serializedName

serializedName: string = "DscCompilationJob"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "DscCompilationJob"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

configuration

configuration: object

serializedName

serializedName: string = "properties.configuration"

type

type: object

className

className: string = "DscConfigurationAssociationProperty"

name

name: "Composite" = "Composite"

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

endTime

endTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

exception

exception: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.exception"

type

type: object

name

name: "String" = "String"

jobId

jobId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.jobId"

type

type: object

name

name: "Uuid" = "Uuid"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastStatusModifiedTime

lastStatusModifiedTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastStatusModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "properties.runOn"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

startedBy

startedBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startedBy"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

serializedName

serializedName: string = "properties.statusDetails"

type

type: object

name

name: "String" = "String"

Const DscCompilationJobCreateParameters

DscCompilationJobCreateParameters: object
interface

An interface representing DscCompilationJobCreateParameters. The parameters supplied to the create compilation job operation.

configuration

member

{DscConfigurationAssociationProperty} configuration Gets or sets the configuration.

Optional incrementNodeConfigurationBuild

incrementNodeConfigurationBuild: undefined | false | true
member

{boolean} [incrementNodeConfigurationBuild] If a new build version of NodeConfiguration is required.

Optional location

location: undefined | string
member

{string} [location] Gets or sets the location of the resource.

Optional name

name: undefined | string
member

{string} [name] Gets or sets name of the resource.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the job.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "DscCompilationJobCreateParameters"

type

type: object

className

className: string = "DscCompilationJobCreateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

configuration

configuration: object

required

required: true = true

serializedName

serializedName: string = "properties.configuration"

type

type: object

className

className: string = "DscConfigurationAssociationProperty"

name

name: "Composite" = "Composite"

incrementNodeConfigurationBuild

incrementNodeConfigurationBuild: object

serializedName

serializedName: string = "properties.incrementNodeConfigurationBuild"

type

type: object

name

name: "Boolean" = "Boolean"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const DscCompilationJobListResult

DscCompilationJobListResult: object
interface

An interface representing the DscCompilationJobListResult. The response model for the list job operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "DscCompilationJobListResult"

__@iterator

  • Iterator

    Returns IterableIterator<DscCompilationJob>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DscCompilationJob>[]

      Additional items to add to the end of array1.

    Returns DscCompilationJob[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DscCompilationJob[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DscCompilationJob]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DscCompilationJob, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DscCompilationJob

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DscCompilationJob[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DscCompilationJob[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DscCompilationJob | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns DscCompilationJob | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DscCompilationJob, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DscCompilationJob

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DscCompilationJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DscCompilationJob, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DscCompilationJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns DscCompilationJob | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DscCompilationJob

  • Parameters

    Returns DscCompilationJob

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DscCompilationJob

  • Parameters

    Returns DscCompilationJob

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns DscCompilationJob[]

shift

  • Removes the first element from an array and returns it.

    Returns DscCompilationJob | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DscCompilationJob[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DscCompilationJob[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DscCompilationJob[]

      Elements to insert into the array in place of the deleted elements.

    Returns DscCompilationJob[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<DscCompilationJob>

type

type: object

className

className: string = "DscCompilationJobListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DscCompilationJob"

name

name: "Composite" = "Composite"

Const DscConfiguration

DscConfiguration: object
interface

An interface representing DscConfiguration. Definition of the configuration type.

extends

TrackedResource

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional etag

etag: undefined | string
member

{string} [etag] Gets or sets the etag of the resource.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobCount

jobCount: undefined | number
member

{number} [jobCount] Gets or sets the job count of the configuration.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time.

Optional location

location: undefined | string
member

{string} [location] The Azure Region where the resource lives

Optional logVerbose

logVerbose: undefined | false | true
member

{boolean} [logVerbose] Gets or sets verbose log option.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional nodeConfigurationCount

nodeConfigurationCount: undefined | number
member

{number} [nodeConfigurationCount] Gets the number of compiled node configurations.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: DscConfigurationParameter }} [parameters] Gets or sets the configuration parameters.

Optional provisioningState

member

{DscConfigurationProvisioningState} [provisioningState] Gets or sets the provisioning state of the configuration. Possible values include: 'Succeeded'

Optional source

member

{ContentSource} [source] Gets or sets the source.

Optional state

member

{DscConfigurationState} [state] Gets or sets the state of the configuration. Possible values include: 'New', 'Edit', 'Published'

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

serializedName

serializedName: string = "DscConfiguration"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "DscConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

jobCount

jobCount: object

serializedName

serializedName: string = "properties.jobCount"

type

type: object

name

name: "Number" = "Number"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

logVerbose

logVerbose: object

serializedName

serializedName: string = "properties.logVerbose"

type

type: object

name

name: "Boolean" = "Boolean"

nodeConfigurationCount

nodeConfigurationCount: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.nodeConfigurationCount"

type

type: object

name

name: "Number" = "Number"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "DscConfigurationParameter"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded"]

name

name: "Enum" = "Enum"

source

source: object

serializedName

serializedName: string = "properties.source"

type

type: object

className

className: string = "ContentSource"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const DscConfigurationAssociationProperty

DscConfigurationAssociationProperty: object
interface

An interface representing DscConfigurationAssociationProperty. The Dsc configuration property associated with the entity.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the Dsc configuration.

serializedName

serializedName: string = "DscConfigurationAssociationProperty"

type

type: object

className

className: string = "DscConfigurationAssociationProperty"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const DscConfigurationCreateOrUpdateParameters

DscConfigurationCreateOrUpdateParameters: object
interface

An interface representing DscConfigurationCreateOrUpdateParameters. The parameters supplied to the create or update configuration operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the configuration.

Optional location

location: undefined | string
member

{string} [location] Gets or sets the location of the resource.

Optional logProgress

logProgress: undefined | false | true
member

{boolean} [logProgress] Gets or sets progress log option.

Optional logVerbose

logVerbose: undefined | false | true
member

{boolean} [logVerbose] Gets or sets verbose log option.

Optional name

name: undefined | string
member

{string} [name] Gets or sets name of the resource.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: DscConfigurationParameter }} [parameters] Gets or sets the configuration parameters.

source

member

{ContentSource} source Gets or sets the source.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "DscConfigurationCreateOrUpdateParameters"

type

type: object

className

className: string = "DscConfigurationCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

logProgress

logProgress: object

serializedName

serializedName: string = "properties.logProgress"

type

type: object

name

name: "Boolean" = "Boolean"

logVerbose

logVerbose: object

serializedName

serializedName: string = "properties.logVerbose"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "DscConfigurationParameter"

name

name: "Composite" = "Composite"

source

source: object

required

required: true = true

serializedName

serializedName: string = "properties.source"

type

type: object

className

className: string = "ContentSource"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const DscConfigurationListResult

DscConfigurationListResult: object
interface

An interface representing the DscConfigurationListResult. The response model for the list configuration operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

Optional totalCount

totalCount: undefined | number
member

{number} [totalCount] Gets the total number of configurations matching filter criteria.

serializedName

serializedName: string = "DscConfigurationListResult"

__@iterator

  • Iterator

    Returns IterableIterator<DscConfiguration>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DscConfiguration>[]

      Additional items to add to the end of array1.

    Returns DscConfiguration[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DscConfiguration[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DscConfiguration]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DscConfiguration, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DscConfiguration

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DscConfiguration[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DscConfiguration[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DscConfiguration | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns DscConfiguration | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DscConfiguration, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DscConfiguration

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: DscConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DscConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DscConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DscConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns DscConfiguration | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DscConfiguration

  • Parameters

    Returns DscConfiguration

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DscConfiguration

  • Parameters

    Returns DscConfiguration

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns DscConfiguration[]

shift

  • Removes the first element from an array and returns it.

    Returns DscConfiguration | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): DscConfiguration[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DscConfiguration[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DscConfiguration[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DscConfiguration[]

      Elements to insert into the array in place of the deleted elements.

    Returns DscConfiguration[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: DscConfiguration[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<DscConfiguration>

type

type: object

className

className: string = "DscConfigurationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

totalCount

totalCount: object

serializedName

serializedName: string = "totalCount"

type

type: object

name

name: "Number" = "Number"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DscConfiguration"

name

name: "Composite" = "Composite"

Const DscConfigurationParameter

DscConfigurationParameter: object
interface

An interface representing DscConfigurationParameter. Definition of the configuration parameter type.

Optional defaultValue

defaultValue: undefined | string
member

{string} [defaultValue] Gets or sets the default value of parameter.

Optional isMandatory

isMandatory: undefined | false | true
member

{boolean} [isMandatory] Gets or sets a Boolean value to indicate whether the parameter is madatory or not.

Optional position

position: undefined | number
member

{number} [position] Get or sets the position of the parameter.

serializedName

serializedName: string = "DscConfigurationParameter"

Optional type

type: object
member

{string} [type] Gets or sets the type of the parameter.

className

className: string = "DscConfigurationParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultValue

defaultValue: object

serializedName

serializedName: string = "defaultValue"

type

type: object

name

name: "String" = "String"

isMandatory

isMandatory: object

serializedName

serializedName: string = "isMandatory"

type

type: object

name

name: "Boolean" = "Boolean"

position

position: object

serializedName

serializedName: string = "position"

type

type: object

name

name: "Number" = "Number"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const DscConfigurationUpdateParameters

DscConfigurationUpdateParameters: object
interface

An interface representing DscConfigurationUpdateParameters. The parameters supplied to the create or update configuration operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the configuration.

Optional logProgress

logProgress: undefined | false | true
member

{boolean} [logProgress] Gets or sets progress log option.

Optional logVerbose

logVerbose: undefined | false | true
member

{boolean} [logVerbose] Gets or sets verbose log option.

Optional name

name: undefined | string
member

{string} [name] Gets or sets name of the resource.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: DscConfigurationParameter }} [parameters] Gets or sets the configuration parameters.

source

member

{ContentSource} source Gets or sets the source.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "DscConfigurationUpdateParameters"

type

type: object

className

className: string = "DscConfigurationUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

logProgress

logProgress: object

serializedName

serializedName: string = "properties.logProgress"

type

type: object

name

name: "Boolean" = "Boolean"

logVerbose

logVerbose: object

serializedName

serializedName: string = "properties.logVerbose"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "DscConfigurationParameter"

name

name: "Composite" = "Composite"

source

source: object

required

required: true = true

serializedName

serializedName: string = "properties.source"

type

type: object

className

className: string = "ContentSource"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const DscMetaConfiguration

DscMetaConfiguration: object
interface

An interface representing DscMetaConfiguration. Definition of the DSC Meta Configuration.

Optional actionAfterReboot

actionAfterReboot: undefined | string
member

{string} [actionAfterReboot] Gets or sets the ActionAfterReboot value of the meta configuration.

Optional allowModuleOverwrite

allowModuleOverwrite: undefined | false | true
member

{boolean} [allowModuleOverwrite] Gets or sets the AllowModuleOverwrite value of the meta configuration.

Optional certificateId

certificateId: undefined | string
member

{string} [certificateId] Gets or sets the CertificateId value of the meta configuration.

Optional configurationMode

configurationMode: undefined | string
member

{string} [configurationMode] Gets or sets the ConfigurationMode value of the meta configuration.

Optional configurationModeFrequencyMins

configurationModeFrequencyMins: undefined | number
member

{number} [configurationModeFrequencyMins] Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration.

Optional rebootNodeIfNeeded

rebootNodeIfNeeded: undefined | false | true
member

{boolean} [rebootNodeIfNeeded] Gets or sets the RebootNodeIfNeeded value of the meta configuration.

Optional refreshFrequencyMins

refreshFrequencyMins: undefined | number
member

{number} [refreshFrequencyMins] Gets or sets the RefreshFrequencyMins value of the meta configuration.

serializedName

serializedName: string = "DscMetaConfiguration"

type

type: object

className

className: string = "DscMetaConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionAfterReboot

actionAfterReboot: object

serializedName

serializedName: string = "actionAfterReboot"

type

type: object

name

name: "String" = "String"

allowModuleOverwrite

allowModuleOverwrite: object

serializedName

serializedName: string = "allowModuleOverwrite"

type

type: object

name

name: "Boolean" = "Boolean"

certificateId

certificateId: object

serializedName

serializedName: string = "certificateId"

type

type: object

name

name: "String" = "String"

configurationMode

configurationMode: object

serializedName

serializedName: string = "configurationMode"

type

type: object

name

name: "String" = "String"

configurationModeFrequencyMins

configurationModeFrequencyMins: object

serializedName

serializedName: string = "configurationModeFrequencyMins"

type

type: object

name

name: "Number" = "Number"

rebootNodeIfNeeded

rebootNodeIfNeeded: object

serializedName

serializedName: string = "rebootNodeIfNeeded"

type

type: object

name

name: "Boolean" = "Boolean"

refreshFrequencyMins

refreshFrequencyMins: object

serializedName

serializedName: string = "refreshFrequencyMins"

type

type: object

name

name: "Number" = "Number"

Const DscNode

DscNode: object
interface

An interface representing DscNode. Definition of a DscNode

extends

ProxyResource

Optional accountId

accountId: undefined | string
member

{string} [accountId] Gets or sets the account id of the node.

Optional dscNodeName

dscNodeName: undefined | string
member

{string} [dscNodeName] Gets or sets the name of the dsc nodeconfiguration.

Optional etag

etag: undefined | string
member

{string} [etag] Gets or sets the etag of the resource.

Optional extensionHandler

member

{DscNodeExtensionHandlerAssociationProperty[]} [extensionHandler] Gets or sets the list of extensionHandler properties for a Node.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional ip

ip: undefined | string
member

{string} [ip] Gets or sets the ip of the node.

Optional lastSeen

lastSeen: Date
member

{Date} [lastSeen] Gets or sets the last seen time of the node.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional nodeId

nodeId: undefined | string
member

{string} [nodeId] Gets or sets the node id.

Optional registrationTime

registrationTime: Date
member

{Date} [registrationTime] Gets or sets the registration time of the node.

Optional status

status: undefined | string
member

{string} [status] Gets or sets the status of the node.

Optional totalCount

totalCount: undefined | number
member

{number} [totalCount] Gets the total number of records matching filter criteria.

serializedName

serializedName: string = "DscNode"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "DscNode"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accountId

accountId: object

serializedName

serializedName: string = "properties.accountId"

type

type: object

name

name: "String" = "String"

dscNodeName

dscNodeName: object

serializedName

serializedName: string = "properties.nodeConfiguration.name"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "properties.etag"

type

type: object

name

name: "String" = "String"

extensionHandler

extensionHandler: object

serializedName

serializedName: string = "properties.extensionHandler"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DscNodeExtensionHandlerAssociationProperty"

name

name: "Composite" = "Composite"

ip

ip: object

serializedName

serializedName: string = "properties.ip"

type

type: object

name

name: "String" = "String"

lastSeen

lastSeen: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastSeen"

type

type: object

name

name: "DateTime" = "DateTime"

nodeId

nodeId: object

serializedName

serializedName: string = "properties.nodeId"

type

type: object

name

name: "String" = "String"

registrationTime

registrationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.registrationTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

totalCount

totalCount: object

serializedName

serializedName: string = "properties.totalCount"

type

type: object

name

name: "Number" = "Number"

Const DscNodeConfiguration

DscNodeConfiguration: object
interface

An interface representing DscNodeConfiguration. Definition of the dsc node configuration.

extends

ProxyResource

Optional configuration

member

{DscConfigurationAssociationProperty} [configuration] Gets or sets the configuration of the node.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets creation time.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional incrementNodeConfigurationBuild

incrementNodeConfigurationBuild: undefined | false | true
member

{boolean} [incrementNodeConfigurationBuild] If a new build version of NodeConfiguration is required.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional nodeCount

nodeCount: undefined | number
member

{number} [nodeCount] Number of nodes with this nodeconfiguration assigned

Optional source

source: undefined | string
member

{string} [source] Source of node configuration.

serializedName

serializedName: string = "DscNodeConfiguration"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "DscNodeConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

configuration

configuration: object

serializedName

serializedName: string = "properties.configuration"

type

type: object

className

className: string = "DscConfigurationAssociationProperty"

name

name: "Composite" = "Composite"

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

incrementNodeConfigurationBuild

incrementNodeConfigurationBuild: object

serializedName

serializedName: string = "properties.incrementNodeConfigurationBuild"

type

type: object

name

name: "Boolean" = "Boolean"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

nodeCount

nodeCount: object

serializedName

serializedName: string = "properties.nodeCount"

type

type: object

name

name: "Number" = "Number"

source

source: object

serializedName

serializedName: string = "properties.source"

type

type: object

name

name: "String" = "String"

Const DscNodeConfigurationCreateOrUpdateParameters

DscNodeConfigurationCreateOrUpdateParameters: object
interface

An interface representing DscNodeConfigurationCreateOrUpdateParameters. The parameters supplied to the create or update node configuration operation.

configuration

member

{DscConfigurationAssociationProperty} configuration Gets or sets the configuration of the node.

Optional incrementNodeConfigurationBuild

incrementNodeConfigurationBuild: undefined | false | true
member

{boolean} [incrementNodeConfigurationBuild] If a new build version of NodeConfiguration is required.

Optional name

name: undefined | string
member

{string} [name] Name of the node configuration.

source

member

{ContentSource} source Gets or sets the source.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "DscNodeConfigurationCreateOrUpdateParameters"

type

type: object

className

className: string = "DscNodeConfigurationCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

configuration

configuration: object

required

required: true = true

serializedName

serializedName: string = "properties.configuration"

type

type: object

className

className: string = "DscConfigurationAssociationProperty"

name

name: "Composite" = "Composite"

incrementNodeConfigurationBuild

incrementNodeConfigurationBuild: object

serializedName

serializedName: string = "properties.incrementNodeConfigurationBuild"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

source

source: object

required

required: true = true

serializedName

serializedName: string = "properties.source"

type

type: object

className

className: string = "ContentSource"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const DscNodeConfigurationListResult

DscNodeConfigurationListResult: object
interface

An interface representing the DscNodeConfigurationListResult. The response model for the list job operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

Optional totalCount

totalCount: undefined | number
member

{number} [totalCount] Gets or sets the total rows in query.

serializedName

serializedName: string = "DscNodeConfigurationListResult"

__@iterator

  • Iterator

    Returns IterableIterator<DscNodeConfiguration>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns DscNodeConfiguration[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DscNodeConfiguration[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DscNodeConfiguration]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DscNodeConfiguration

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DscNodeConfiguration[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DscNodeConfiguration[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DscNodeConfiguration | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns DscNodeConfiguration | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DscNodeConfiguration

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DscNodeConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DscNodeConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns DscNodeConfiguration | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DscNodeConfiguration

  • Parameters

    Returns DscNodeConfiguration

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DscNodeConfiguration

  • Parameters

    Returns DscNodeConfiguration

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns DscNodeConfiguration[]

shift

  • Removes the first element from an array and returns it.

    Returns DscNodeConfiguration | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DscNodeConfiguration[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DscNodeConfiguration[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DscNodeConfiguration[]

      Elements to insert into the array in place of the deleted elements.

    Returns DscNodeConfiguration[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<DscNodeConfiguration>

type

type: object

className

className: string = "DscNodeConfigurationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

totalCount

totalCount: object

serializedName

serializedName: string = "totalCount"

type

type: object

name

name: "Number" = "Number"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DscNodeConfiguration"

name

name: "Composite" = "Composite"

Const DscNodeExtensionHandlerAssociationProperty

DscNodeExtensionHandlerAssociationProperty: object
interface

An interface representing DscNodeExtensionHandlerAssociationProperty. The dsc extensionHandler property associated with the node

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the extension handler.

Optional version

version: undefined | string
member

{string} [version] Gets or sets the version of the extension handler.

serializedName

serializedName: string = "DscNodeExtensionHandlerAssociationProperty"

type

type: object

className

className: string = "DscNodeExtensionHandlerAssociationProperty"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const DscNodeListResult

DscNodeListResult: object
interface

An interface representing the DscNodeListResult. The response model for the list dsc nodes operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

Optional totalCount

totalCount: undefined | number
member

{number} [totalCount] Gets the total number of nodes matching filter criteria.

serializedName

serializedName: string = "DscNodeListResult"

__@iterator

  • __@iterator(): IterableIterator<DscNode>
  • Iterator

    Returns IterableIterator<DscNode>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<DscNode>[]): DscNode[]
  • concat(...items: (T | ConcatArray<T>)[]): DscNode[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DscNode>[]

      Additional items to add to the end of array1.

    Returns DscNode[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DscNode[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, DscNode]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DscNode]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DscNode, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DscNode

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DscNode[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DscNode[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DscNode | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: DscNode, index: number, obj: DscNode[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns DscNode | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DscNode, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DscNode

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: DscNode, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DscNode

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DscNode, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DscNode

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns DscNode | undefined

push

  • push(...items: DscNode[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: DscNode[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): DscNode
  • reduce(callbackfn: function, initialValue: DscNode): DscNode
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns DscNode

  • Parameters

    Returns DscNode

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DscNode, currentIndex: number, array: DscNode[]): U
        • Parameters

          • previousValue: U
          • currentValue: DscNode
          • currentIndex: number
          • array: DscNode[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): DscNode
  • reduceRight(callbackfn: function, initialValue: DscNode): DscNode
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns DscNode

  • Parameters

    Returns DscNode

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DscNode, currentIndex: number, array: DscNode[]): U
        • Parameters

          • previousValue: U
          • currentValue: DscNode
          • currentIndex: number
          • array: DscNode[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns DscNode[]

shift

  • Removes the first element from an array and returns it.

    Returns DscNode | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): DscNode[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DscNode[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): DscNode[]
  • splice(start: number, deleteCount: number, ...items: DscNode[]): DscNode[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DscNode[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DscNode[]

      Elements to insert into the array in place of the deleted elements.

    Returns DscNode[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: DscNode[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: DscNode[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<DscNode>
  • Returns an iterable of values in the array

    Returns IterableIterator<DscNode>

type

type: object

className

className: string = "DscNodeListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

totalCount

totalCount: object

serializedName

serializedName: string = "totalCount"

type

type: object

name

name: "Number" = "Number"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DscNode"

name

name: "Composite" = "Composite"

Const DscNodeReport

DscNodeReport: object
interface

An interface representing DscNodeReport. Definition of the dsc node report type.

Optional configurationVersion

configurationVersion: undefined | string
member

{string} [configurationVersion] Gets or sets the configurationVersion of the node report.

Optional endTime

endTime: Date
member

{Date} [endTime] Gets or sets the end time of the node report.

Optional errors

errors: DscReportError[]
member

{DscReportError[]} [errors] Gets or sets the errors for the node report.

Optional hostName

hostName: undefined | string
member

{string} [hostName] Gets or sets the hostname of the node that sent the report.

Optional iPV4Addresses

iPV4Addresses: string[]
member

{string[]} [iPV4Addresses] Gets or sets the IPv4 address of the node that sent the report.

Optional iPV6Addresses

iPV6Addresses: string[]
member

{string[]} [iPV6Addresses] Gets or sets the IPv6 address of the node that sent the report.

Optional id

id: undefined | string
member

{string} [id] Gets or sets the id.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the lastModifiedTime of the node report.

Optional metaConfiguration

metaConfiguration: DscMetaConfiguration
member

{DscMetaConfiguration} [metaConfiguration] Gets or sets the metaConfiguration of the node at the time of the report.

Optional numberOfResources

numberOfResources: undefined | number
member

{number} [numberOfResources] Gets or sets the number of resource in the node report.

Optional rawErrors

rawErrors: undefined | string
member

{string} [rawErrors] Gets or sets the unparsed errors for the node report.

Optional rebootRequested

rebootRequested: undefined | string
member

{string} [rebootRequested] Gets or sets the rebootRequested of the node report.

Optional refreshMode

refreshMode: undefined | string
member

{string} [refreshMode] Gets or sets the refreshMode of the node report.

Optional reportFormatVersion

reportFormatVersion: undefined | string
member

{string} [reportFormatVersion] Gets or sets the reportFormatVersion of the node report.

Optional reportId

reportId: undefined | string
member

{string} [reportId] Gets or sets the id of the node report.

Optional resources

resources: DscReportResource[]
member

{DscReportResource[]} [resources] Gets or sets the resource for the node report.

Optional startTime

startTime: Date
member

{Date} [startTime] Gets or sets the start time of the node report.

Optional status

status: undefined | string
member

{string} [status] Gets or sets the status of the node report.

serializedName

serializedName: string = "DscNodeReport"

Optional type

type: object
member

{string} [type] Gets or sets the type of the node report.

className

className: string = "DscNodeReport"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

configurationVersion

configurationVersion: object

serializedName

serializedName: string = "configurationVersion"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DscReportError"

name

name: "Composite" = "Composite"

hostName

hostName: object

serializedName

serializedName: string = "hostName"

type

type: object

name

name: "String" = "String"

iPV4Addresses

iPV4Addresses: object

serializedName

serializedName: string = "iPV4Addresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

iPV6Addresses

iPV6Addresses: object

serializedName

serializedName: string = "iPV6Addresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

metaConfiguration

metaConfiguration: object

serializedName

serializedName: string = "metaConfiguration"

type

type: object

className

className: string = "DscMetaConfiguration"

name

name: "Composite" = "Composite"

numberOfResources

numberOfResources: object

serializedName

serializedName: string = "numberOfResources"

type

type: object

name

name: "Number" = "Number"

rawErrors

rawErrors: object

serializedName

serializedName: string = "rawErrors"

type

type: object

name

name: "String" = "String"

rebootRequested

rebootRequested: object

serializedName

serializedName: string = "rebootRequested"

type

type: object

name

name: "String" = "String"

refreshMode

refreshMode: object

serializedName

serializedName: string = "refreshMode"

type

type: object

name

name: "String" = "String"

reportFormatVersion

reportFormatVersion: object

serializedName

serializedName: string = "reportFormatVersion"

type

type: object

name

name: "String" = "String"

reportId

reportId: object

serializedName

serializedName: string = "reportId"

type

type: object

name

name: "String" = "String"

resources

resources: object

serializedName

serializedName: string = "resources"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DscReportResource"

name

name: "Composite" = "Composite"

startTime

startTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const DscNodeReportListResult

DscNodeReportListResult: object
interface

An interface representing the DscNodeReportListResult. The response model for the list dsc nodes operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "DscNodeReportListResult"

__@iterator

  • Iterator

    Returns IterableIterator<DscNodeReport>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DscNodeReport>[]

      Additional items to add to the end of array1.

    Returns DscNodeReport[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DscNodeReport[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DscNodeReport]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DscNodeReport, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DscNodeReport

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DscNodeReport[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DscNodeReport[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DscNodeReport | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns DscNodeReport | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DscNodeReport, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DscNodeReport

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: DscNodeReport, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DscNodeReport

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DscNodeReport, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DscNodeReport

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns DscNodeReport | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DscNodeReport

  • Parameters

    Returns DscNodeReport

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DscNodeReport

  • Parameters

    Returns DscNodeReport

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns DscNodeReport[]

shift

  • Removes the first element from an array and returns it.

    Returns DscNodeReport | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): DscNodeReport[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DscNodeReport[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DscNodeReport[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DscNodeReport[]

      Elements to insert into the array in place of the deleted elements.

    Returns DscNodeReport[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: DscNodeReport[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<DscNodeReport>

type

type: object

className

className: string = "DscNodeReportListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DscNodeReport"

name

name: "Composite" = "Composite"

Const DscNodeUpdateParameters

DscNodeUpdateParameters: object
interface

An interface representing DscNodeUpdateParameters. The parameters supplied to the update dsc node operation.

Optional nodeId

nodeId: undefined | string
member

{string} [nodeId] Gets or sets the id of the dsc node.

Optional properties

member

{DscNodeUpdateParametersProperties} [properties]

serializedName

serializedName: string = "DscNodeUpdateParameters"

type

type: object

className

className: string = "DscNodeUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeId

nodeId: object

serializedName

serializedName: string = "nodeId"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "DscNodeUpdateParametersProperties"

name

name: "Composite" = "Composite"

Const DscNodeUpdateParametersProperties

DscNodeUpdateParametersProperties: object
interface

An interface representing DscNodeUpdateParametersProperties.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the dsc nodeconfiguration.

serializedName

serializedName: string = "DscNodeUpdateParameters_properties"

type

type: object

className

className: string = "DscNodeUpdateParametersProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "nodeConfiguration.name"

type

type: object

name

name: "String" = "String"

Const DscReportError

DscReportError: object
interface

An interface representing DscReportError. Definition of the dsc node report error type.

Optional errorCode

errorCode: undefined | string
member

{string} [errorCode] Gets or sets the error code.

Optional errorDetails

errorDetails: undefined | string
member

{string} [errorDetails] Gets or sets the error details.

Optional errorMessage

errorMessage: undefined | string
member

{string} [errorMessage] Gets or sets the error message.

Optional errorSource

errorSource: undefined | string
member

{string} [errorSource] Gets or sets the source of the error.

Optional locale

locale: undefined | string
member

{string} [locale] Gets or sets the locale of the error.

Optional resourceId

resourceId: undefined | string
member

{string} [resourceId] Gets or sets the resource ID which generated the error.

serializedName

serializedName: string = "DscReportError"

type

type: object

className

className: string = "DscReportError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "String" = "String"

errorDetails

errorDetails: object

serializedName

serializedName: string = "errorDetails"

type

type: object

name

name: "String" = "String"

errorMessage

errorMessage: object

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: "String" = "String"

errorSource

errorSource: object

serializedName

serializedName: string = "errorSource"

type

type: object

name

name: "String" = "String"

locale

locale: object

serializedName

serializedName: string = "locale"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

Const DscReportResource

DscReportResource: object
interface

An interface representing DscReportResource. Definition of the DSC Report Resource.

Optional dependsOn

member

{DscReportResourceNavigation[]} [dependsOn] Gets or sets the Resource Navigation values for resources the resource depends on.

Optional durationInSeconds

durationInSeconds: undefined | number
member

{number} [durationInSeconds] Gets or sets the duration in seconds for the resource.

Optional error

error: undefined | string
member

{string} [error] Gets or sets the error of the resource.

Optional moduleName

moduleName: undefined | string
member

{string} [moduleName] Gets or sets the module name of the resource.

Optional moduleVersion

moduleVersion: undefined | string
member

{string} [moduleVersion] Gets or sets the module version of the resource.

Optional resourceId

resourceId: undefined | string
member

{string} [resourceId] Gets or sets the ID of the resource.

Optional resourceName

resourceName: undefined | string
member

{string} [resourceName] Gets or sets the name of the resource.

Optional sourceInfo

sourceInfo: undefined | string
member

{string} [sourceInfo] Gets or sets the source info of the resource.

Optional startDate

startDate: Date
member

{Date} [startDate] Gets or sets the start date of the resource.

Optional status

status: undefined | string
member

{string} [status] Gets or sets the status of the resource.

serializedName

serializedName: string = "DscReportResource"

type

type: object

className

className: string = "DscReportResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dependsOn

dependsOn: object

serializedName

serializedName: string = "dependsOn"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DscReportResourceNavigation"

name

name: "Composite" = "Composite"

durationInSeconds

durationInSeconds: object

serializedName

serializedName: string = "durationInSeconds"

type

type: object

name

name: "Number" = "Number"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

name

name: "String" = "String"

moduleName

moduleName: object

serializedName

serializedName: string = "moduleName"

type

type: object

name

name: "String" = "String"

moduleVersion

moduleVersion: object

serializedName

serializedName: string = "moduleVersion"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

resourceName

resourceName: object

serializedName

serializedName: string = "resourceName"

type

type: object

name

name: "String" = "String"

sourceInfo

sourceInfo: object

serializedName

serializedName: string = "sourceInfo"

type

type: object

name

name: "String" = "String"

startDate

startDate: object

nullable

nullable: false = false

serializedName

serializedName: string = "startDate"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const DscReportResourceNavigation

DscReportResourceNavigation: object
interface

An interface representing DscReportResourceNavigation. Navigation for DSC Report Resource.

Optional resourceId

resourceId: undefined | string
member

{string} [resourceId] Gets or sets the ID of the resource to navigate to.

serializedName

serializedName: string = "DscReportResourceNavigation"

type

type: object

className

className: string = "DscReportResourceNavigation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

Const ErrorResponse

ErrorResponse: object
interface

An interface representing ErrorResponse. Error response of an operation failure

Optional code

code: undefined | string
member

{string} [code] Error code

Optional message

message: undefined | string
member

{string} [message] Error message indicating why the operation failed.

serializedName

serializedName: string = "ErrorResponse"

type

type: object

className

className: string = "ErrorResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const FieldDefinition

FieldDefinition: object
interface

An interface representing FieldDefinition. Definition of the connection fields.

Optional isEncrypted

isEncrypted: undefined | false | true
member

{boolean} [isEncrypted] Gets or sets the isEncrypted flag of the connection field definition.

Optional isOptional

isOptional: undefined | false | true
member

{boolean} [isOptional] Gets or sets the isOptional flag of the connection field definition.

serializedName

serializedName: string = "FieldDefinition"

type

type: object
member

{string} type Gets or sets the type of the connection field definition.

className

className: string = "FieldDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isEncrypted

isEncrypted: object

serializedName

serializedName: string = "isEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

isOptional

isOptional: object

serializedName

serializedName: string = "isOptional"

type

type: object

name

name: "Boolean" = "Boolean"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const HybridRunbookWorker

HybridRunbookWorker: object
interface

An interface representing HybridRunbookWorker. Definition of hybrid runbook worker.

Optional ip

ip: undefined | string
member

{string} [ip] Gets or sets the assigned machine IP address.

Optional lastSeenDateTime

lastSeenDateTime: Date
member

{Date} [lastSeenDateTime] Last Heartbeat from the Worker

Optional name

name: undefined | string
member

{string} [name] Gets or sets the worker machine name.

Optional registrationTime

registrationTime: Date
member

{Date} [registrationTime] Gets or sets the registration time of the worker machine.

serializedName

serializedName: string = "HybridRunbookWorker"

type

type: object

className

className: string = "HybridRunbookWorker"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ip

ip: object

serializedName

serializedName: string = "ip"

type

type: object

name

name: "String" = "String"

lastSeenDateTime

lastSeenDateTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "lastSeenDateTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

registrationTime

registrationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "registrationTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const HybridRunbookWorkerGroup

HybridRunbookWorkerGroup: object
interface

An interface representing HybridRunbookWorkerGroup. Definition of hybrid runbook worker group.

Optional credential

member

{RunAsCredentialAssociationProperty} [credential] Sets the credential of a worker group.

Optional groupType

groupType: GroupTypeEnum
member

{GroupTypeEnum} [groupType] Type of the HybridWorkerGroup. Possible values include: 'User', 'System'

Optional hybridRunbookWorkers

hybridRunbookWorkers: HybridRunbookWorker[]
member

{HybridRunbookWorker[]} [hybridRunbookWorkers] Gets or sets the list of hybrid runbook workers.

Optional id

id: undefined | string
member

{string} [id] Gets or sets the id of the resource.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the group.

serializedName

serializedName: string = "HybridRunbookWorkerGroup"

type

type: object

className

className: string = "HybridRunbookWorkerGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

credential

credential: object

serializedName

serializedName: string = "credential"

type

type: object

className

className: string = "RunAsCredentialAssociationProperty"

name

name: "Composite" = "Composite"

groupType

groupType: object

serializedName

serializedName: string = "groupType"

type

type: object

name

name: "String" = "String"

hybridRunbookWorkers

hybridRunbookWorkers: object

serializedName

serializedName: string = "hybridRunbookWorkers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HybridRunbookWorker"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const HybridRunbookWorkerGroupUpdateParameters

HybridRunbookWorkerGroupUpdateParameters: object
interface

An interface representing HybridRunbookWorkerGroupUpdateParameters. Parameters supplied to the update operation.

Optional credential

member

{RunAsCredentialAssociationProperty} [credential] Sets the credential of a worker group.

serializedName

serializedName: string = "HybridRunbookWorkerGroupUpdateParameters"

type

type: object

className

className: string = "HybridRunbookWorkerGroupUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

credential

credential: object

serializedName

serializedName: string = "credential"

type

type: object

className

className: string = "RunAsCredentialAssociationProperty"

name

name: "Composite" = "Composite"

Const HybridRunbookWorkerGroupsListResult

HybridRunbookWorkerGroupsListResult: object
interface

An interface representing the HybridRunbookWorkerGroupsListResult. The response model for the list hybrid runbook worker groups.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "HybridRunbookWorkerGroupsListResult"

__@iterator

  • Iterator

    Returns IterableIterator<HybridRunbookWorkerGroup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns HybridRunbookWorkerGroup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns HybridRunbookWorkerGroup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, HybridRunbookWorkerGroup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: HybridRunbookWorkerGroup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): HybridRunbookWorkerGroup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns HybridRunbookWorkerGroup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): HybridRunbookWorkerGroup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns HybridRunbookWorkerGroup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: HybridRunbookWorkerGroup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: HybridRunbookWorkerGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: HybridRunbookWorkerGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns HybridRunbookWorkerGroup | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns HybridRunbookWorkerGroup[]

shift

  • Removes the first element from an array and returns it.

    Returns HybridRunbookWorkerGroup | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns HybridRunbookWorkerGroup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns HybridRunbookWorkerGroup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: HybridRunbookWorkerGroup[]

      Elements to insert into the array in place of the deleted elements.

    Returns HybridRunbookWorkerGroup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<HybridRunbookWorkerGroup>

type

type: object

className

className: string = "HybridRunbookWorkerGroupsListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HybridRunbookWorkerGroup"

name

name: "Composite" = "Composite"

Const Job

Job: object
interface

An interface representing Job. Definition of the job.

extends

ProxyResource

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time of the job.

Optional endTime

endTime: Date
member

{Date} [endTime] Gets or sets the end time of the job.

Optional exception

exception: undefined | string
member

{string} [exception] Gets or sets the exception of the job.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobId

jobId: undefined | string
member

{string} [jobId] Gets or sets the id of the job.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time of the job.

Optional lastStatusModifiedTime

lastStatusModifiedTime: Date
member

{Date} [lastStatusModifiedTime] Gets or sets the last status modified time of the job.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the job.

Optional provisioningState

provisioningState: JobProvisioningState
member

{JobProvisioningState} [provisioningState] The current provisioning state of the job. Possible values include: 'Failed', 'Succeeded', 'Suspended', 'Processing'

Optional runOn

runOn: undefined | string
member

{string} [runOn] Gets or sets the runOn which specifies the group name where the job is to be executed.

Optional runbook

member

{RunbookAssociationProperty} [runbook] Gets or sets the runbook.

Optional startTime

startTime: Date
member

{Date} [startTime] Gets or sets the start time of the job.

Optional startedBy

startedBy: undefined | string
member

{string} [startedBy] Gets or sets the job started by.

Optional status

status: JobStatus
member

{JobStatus} [status] Gets or sets the status of the job. Possible values include: 'New', 'Activating', 'Running', 'Completed', 'Failed', 'Stopped', 'Blocked', 'Suspended', 'Disconnected', 'Suspending', 'Stopping', 'Resuming', 'Removing'

Optional statusDetails

statusDetails: undefined | string
member

{string} [statusDetails] Gets or sets the status details of the job.

serializedName

serializedName: string = "Job"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Job"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

endTime

endTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

exception

exception: object

serializedName

serializedName: string = "properties.exception"

type

type: object

name

name: "String" = "String"

jobId

jobId: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.jobId"

type

type: object

name

name: "Uuid" = "Uuid"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastStatusModifiedTime

lastStatusModifiedTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "properties.lastStatusModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "properties.runOn"

type

type: object

name

name: "String" = "String"

runbook

runbook: object

serializedName

serializedName: string = "properties.runbook"

type

type: object

className

className: string = "RunbookAssociationProperty"

name

name: "Composite" = "Composite"

startTime

startTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

startedBy

startedBy: object

serializedName

serializedName: string = "properties.startedBy"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

serializedName

serializedName: string = "properties.statusDetails"

type

type: object

name

name: "String" = "String"

Const JobCollectionItem

JobCollectionItem: object
interface

An interface representing JobCollectionItem. Job collection item properties.

extends

ProxyResource

Optional creationTime

creationTime: Date
member

{Date} [creationTime] The creation time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobId

jobId: undefined | string
member

{string} [jobId] The id of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] The last modified time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string
member

{string} [provisioningState] The provisioning state of a resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runOn

runOn: undefined | string
member

{string} [runOn] Specifies the runOn group name where the job was executed.

Optional runbook

member

{RunbookAssociationProperty} [runbook] The runbook association. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date
member

{Date} [startTime] The start time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: JobStatus
member

{JobStatus} [status] The status of the job. Possible values include: 'New', 'Activating', 'Running', 'Completed', 'Failed', 'Stopped', 'Blocked', 'Suspended', 'Disconnected', 'Suspending', 'Stopping', 'Resuming', 'Removing' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobCollectionItem"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "JobCollectionItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

endTime

endTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

jobId

jobId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.jobId"

type

type: object

name

name: "Uuid" = "Uuid"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "properties.runOn"

type

type: object

name

name: "String" = "String"

runbook

runbook: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.runbook"

type

type: object

className

className: string = "RunbookAssociationProperty"

name

name: "Composite" = "Composite"

startTime

startTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

Const JobCreateParameters

JobCreateParameters: object
interface

An interface representing JobCreateParameters. The parameters supplied to the create job operation.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the job.

Optional runOn

runOn: undefined | string
member

{string} [runOn] Gets or sets the runOn which specifies the group name where the job is to be executed.

Optional runbook

member

{RunbookAssociationProperty} [runbook] Gets or sets the runbook.

serializedName

serializedName: string = "JobCreateParameters"

type

type: object

className

className: string = "JobCreateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "properties.runOn"

type

type: object

name

name: "String" = "String"

runbook

runbook: object

serializedName

serializedName: string = "properties.runbook"

type

type: object

className

className: string = "RunbookAssociationProperty"

name

name: "Composite" = "Composite"

Const JobListResultV2

JobListResultV2: object
interface

An interface representing the JobListResultV2. The response model for the list job operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The link to the next page. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobListResultV2"

__@iterator

  • Iterator

    Returns IterableIterator<JobCollectionItem>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<JobCollectionItem>[]

      Additional items to add to the end of array1.

    Returns JobCollectionItem[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns JobCollectionItem[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobCollectionItem]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: JobCollectionItem, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobCollectionItem

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): JobCollectionItem[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns JobCollectionItem[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): JobCollectionItem | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns JobCollectionItem | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: JobCollectionItem, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: JobCollectionItem

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: JobCollectionItem

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: JobCollectionItem, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobCollectionItem

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns JobCollectionItem | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns JobCollectionItem

  • Parameters

    Returns JobCollectionItem

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns JobCollectionItem

  • Parameters

    Returns JobCollectionItem

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns JobCollectionItem[]

shift

  • Removes the first element from an array and returns it.

    Returns JobCollectionItem | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobCollectionItem[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobCollectionItem[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobCollectionItem[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobCollectionItem[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<JobCollectionItem>

type

type: object

className

className: string = "JobListResultV2"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobCollectionItem"

name

name: "Composite" = "Composite"

Const JobNavigation

JobNavigation: object
interface

An interface representing JobNavigation. Software update configuration machine run job navigation properties.

Optional id

id: undefined | string
member

{string} [id] Id of the job associated with the software update configuration run NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "jobNavigation"

type

type: object

className

className: string = "JobNavigation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const JobSchedule

JobSchedule: object
interface

An interface representing JobSchedule. Definition of the job schedule.

Optional id

id: undefined | string
member

{string} [id] Gets the id of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobScheduleId

jobScheduleId: undefined | string
member

{string} [jobScheduleId] Gets or sets the id of job schedule.

Optional name

name: undefined | string
member

{string} [name] Gets the name of the variable. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the job schedule.

Optional runOn

runOn: undefined | string
member

{string} [runOn] Gets or sets the hybrid worker group that the scheduled job should run on.

Optional runbook

member

{RunbookAssociationProperty} [runbook] Gets or sets the runbook.

Optional schedule

member

{ScheduleAssociationProperty} [schedule] Gets or sets the schedule.

serializedName

serializedName: string = "JobSchedule"

Optional type

type: object
member

{string} [type] Resource type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "JobSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

jobScheduleId

jobScheduleId: object

serializedName

serializedName: string = "properties.jobScheduleId"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "properties.runOn"

type

type: object

name

name: "String" = "String"

runbook

runbook: object

serializedName

serializedName: string = "properties.runbook"

type

type: object

className

className: string = "RunbookAssociationProperty"

name

name: "Composite" = "Composite"

schedule

schedule: object

serializedName

serializedName: string = "properties.schedule"

type

type: object

className

className: string = "ScheduleAssociationProperty"

name

name: "Composite" = "Composite"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const JobScheduleCreateParameters

JobScheduleCreateParameters: object
interface

An interface representing JobScheduleCreateParameters. The parameters supplied to the create job schedule operation.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets a list of job properties.

Optional runOn

runOn: undefined | string
member

{string} [runOn] Gets or sets the hybrid worker group that the scheduled job should run on.

runbook

member

{RunbookAssociationProperty} runbook Gets or sets the runbook.

schedule

member

{ScheduleAssociationProperty} schedule Gets or sets the schedule.

serializedName

serializedName: string = "JobScheduleCreateParameters"

type

type: object

className

className: string = "JobScheduleCreateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "properties.runOn"

type

type: object

name

name: "String" = "String"

runbook

runbook: object

required

required: true = true

serializedName

serializedName: string = "properties.runbook"

type

type: object

className

className: string = "RunbookAssociationProperty"

name

name: "Composite" = "Composite"

schedule

schedule: object

required

required: true = true

serializedName

serializedName: string = "properties.schedule"

type

type: object

className

className: string = "ScheduleAssociationProperty"

name

name: "Composite" = "Composite"

Const JobScheduleListResult

JobScheduleListResult: object
interface

An interface representing the JobScheduleListResult. The response model for the list job schedule operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "JobScheduleListResult"

__@iterator

  • Iterator

    Returns IterableIterator<JobSchedule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<JobSchedule>[]

      Additional items to add to the end of array1.

    Returns JobSchedule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns JobSchedule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobSchedule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: JobSchedule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobSchedule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): JobSchedule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns JobSchedule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): JobSchedule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns JobSchedule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: JobSchedule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: JobSchedule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: JobSchedule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: JobSchedule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: JobSchedule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobSchedule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns JobSchedule | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: JobSchedule[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns JobSchedule

  • Parameters

    Returns JobSchedule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): JobSchedule
  • reduceRight(callbackfn: function, initialValue: JobSchedule): JobSchedule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns JobSchedule

  • Parameters

    Returns JobSchedule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns JobSchedule[]

shift

  • Removes the first element from an array and returns it.

    Returns JobSchedule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): JobSchedule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobSchedule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobSchedule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobSchedule[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobSchedule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: JobSchedule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<JobSchedule>

type

type: object

className

className: string = "JobScheduleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobSchedule"

name

name: "Composite" = "Composite"

Const JobStream

JobStream: object
interface

An interface representing JobStream. Definition of the job stream.

Optional id

id: undefined | string
member

{string} [id] Gets or sets the id of the resource.

Optional jobStreamId

jobStreamId: undefined | string
member

{string} [jobStreamId] Gets or sets the id of the job stream.

Optional streamText

streamText: undefined | string
member

{string} [streamText] Gets or sets the stream text.

Optional streamType

streamType: JobStreamType
member

{JobStreamType} [streamType] Gets or sets the stream type. Possible values include: 'Progress', 'Output', 'Warning', 'Error', 'Debug', 'Verbose', 'Any'

Optional summary

summary: undefined | string
member

{string} [summary] Gets or sets the summary.

Optional time

time: Date
member

{Date} [time] Gets or sets the creation time of the job.

Optional value

value: undefined | object
member

{{ [propertyName: string]: any }} [value] Gets or sets the values of the job stream.

serializedName

serializedName: string = "JobStream"

type

type: object

className

className: string = "JobStream"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

jobStreamId

jobStreamId: object

serializedName

serializedName: string = "properties.jobStreamId"

type

type: object

name

name: "String" = "String"

streamText

streamText: object

serializedName

serializedName: string = "properties.streamText"

type

type: object

name

name: "String" = "String"

streamType

streamType: object

serializedName

serializedName: string = "properties.streamType"

type

type: object

name

name: "String" = "String"

summary

summary: object

serializedName

serializedName: string = "properties.summary"

type

type: object

name

name: "String" = "String"

time

time: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.time"

type

type: object

name

name: "DateTime" = "DateTime"

value

value: object

serializedName

serializedName: string = "properties.value"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

Const JobStreamListResult

JobStreamListResult: object
interface

An interface representing the JobStreamListResult. The response model for the list job stream operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "JobStreamListResult"

__@iterator

  • Iterator

    Returns IterableIterator<JobStream>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<JobStream>[]

      Additional items to add to the end of array1.

    Returns JobStream[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns JobStream[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, JobStream]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobStream]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: JobStream, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobStream

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): JobStream[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns JobStream[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): JobStream | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns JobStream | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: JobStream, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: JobStream

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: JobStream, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: JobStream

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: JobStream, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobStream

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns JobStream | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: JobStream[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): JobStream
  • reduce(callbackfn: function, initialValue: JobStream): JobStream
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns JobStream

  • Parameters

    Returns JobStream

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobStream, currentIndex: number, array: JobStream[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): JobStream
  • reduceRight(callbackfn: function, initialValue: JobStream): JobStream
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns JobStream

  • Parameters

    Returns JobStream

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobStream, currentIndex: number, array: JobStream[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns JobStream[]

shift

  • Removes the first element from an array and returns it.

    Returns JobStream | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): JobStream[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobStream[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): JobStream[]
  • splice(start: number, deleteCount: number, ...items: JobStream[]): JobStream[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobStream[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobStream[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobStream[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: JobStream[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<JobStream>

type

type: object

className

className: string = "JobStreamListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobStream"

name

name: "Composite" = "Composite"

Const Key

Key: object
interface

An interface representing Key. Automation key which is used to register a DSC Node

Optional keyName

member

{AutomationKeyName} [keyName] Automation key name. Possible values include: 'Primary', 'Secondary' NOTE: This property will not be serialized. It can only be populated by the server.

Optional permissions

member

{AutomationKeyPermissions} [permissions] Automation key permissions. Possible values include: 'Read', 'Full' NOTE: This property will not be serialized. It can only be populated by the server.

Optional value

value: undefined | string
member

{string} [value] Value of the Automation Key used for registration. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Key"

type

type: object

className

className: string = "Key"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyName

keyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "KeyName"

type

type: object

name

name: "String" = "String"

permissions

permissions: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "Permissions"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "Value"

type

type: object

name

name: "String" = "String"

Const KeyListResult

KeyListResult: object
interface

An interface representing KeyListResult.

Optional keys

keys: Key[]
member

{Key[]} [keys] Lists the automation keys.

serializedName

serializedName: string = "KeyListResult"

type

type: object

className

className: string = "KeyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keys

keys: object

serializedName

serializedName: string = "keys"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Key"

name

name: "Composite" = "Composite"

Const LinkedWorkspace

LinkedWorkspace: object
interface

An interface representing LinkedWorkspace. Definition of the linked workspace.

Optional id

id: undefined | string
member

{string} [id] Gets the id of the linked workspace. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LinkedWorkspace"

type

type: object

className

className: string = "LinkedWorkspace"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const LinuxProperties

LinuxProperties: object
interface

An interface representing LinuxProperties. Linux specific update configuration.

Optional excludedPackageNameMasks

excludedPackageNameMasks: string[]
member

{string[]} [excludedPackageNameMasks] packages excluded from the software update configuration.

Optional includedPackageClassifications

includedPackageClassifications: LinuxUpdateClasses
member

{LinuxUpdateClasses} [includedPackageClassifications] Update classifications included in the software update configuration. Possible values include: 'Unclassified', 'Critical', 'Security', 'Other'

Optional includedPackageNameMasks

includedPackageNameMasks: string[]
member

{string[]} [includedPackageNameMasks] packages included from the software update configuration.

Optional rebootSetting

rebootSetting: undefined | string
member

{string} [rebootSetting] Reboot setting for the software update configuration.

serializedName

serializedName: string = "LinuxProperties"

type

type: object

className

className: string = "LinuxProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

excludedPackageNameMasks

excludedPackageNameMasks: object

serializedName

serializedName: string = "excludedPackageNameMasks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

includedPackageClassifications

includedPackageClassifications: object

serializedName

serializedName: string = "includedPackageClassifications"

type

type: object

name

name: "String" = "String"

includedPackageNameMasks

includedPackageNameMasks: object

serializedName

serializedName: string = "includedPackageNameMasks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

rebootSetting

rebootSetting: object

serializedName

serializedName: string = "rebootSetting"

type

type: object

name

name: "String" = "String"

Const Module

Module: object
interface

An interface representing Module. Definition of the module type.

extends

TrackedResource

Optional activityCount

activityCount: undefined | number
member

{number} [activityCount] Gets or sets the activity count of the module.

Optional contentLink

contentLink: ContentLink
member

{ContentLink} [contentLink] Gets or sets the contentLink of the module.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional error

member

{ModuleErrorInfo} [error] Gets or sets the error info of the module.

Optional etag

etag: undefined | string
member

{string} [etag] Gets or sets the etag of the resource.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional isComposite

isComposite: undefined | false | true
member

{boolean} [isComposite] Gets or sets type of module, if its composite or not.

Optional isGlobal

isGlobal: undefined | false | true
member

{boolean} [isGlobal] Gets or sets the isGlobal flag of the module.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time.

Optional location

location: undefined | string
member

{string} [location] The Azure Region where the resource lives

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ModuleProvisioningState
member

{ModuleProvisioningState} [provisioningState] Gets or sets the provisioning state of the module. Possible values include: 'Created', 'Creating', 'StartingImportModuleRunbook', 'RunningImportModuleRunbook', 'ContentRetrieved', 'ContentDownloaded', 'ContentValidated', 'ConnectionTypeImported', 'ContentStored', 'ModuleDataStored', 'ActivitiesStored', 'ModuleImportRunbookComplete', 'Succeeded', 'Failed', 'Cancelled', 'Updating'

Optional sizeInBytes

sizeInBytes: undefined | number
member

{number} [sizeInBytes] Gets or sets the size in bytes of the module.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

Optional version

version: undefined | string
member

{string} [version] Gets or sets the version of the module.

serializedName

serializedName: string = "Module"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Module"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activityCount

activityCount: object

serializedName

serializedName: string = "properties.activityCount"

type

type: object

name

name: "Number" = "Number"

contentLink

contentLink: object

serializedName

serializedName: string = "properties.contentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

error

error: object

serializedName

serializedName: string = "properties.error"

type

type: object

className

className: string = "ModuleErrorInfo"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

isComposite

isComposite: object

serializedName

serializedName: string = "properties.isComposite"

type

type: object

name

name: "Boolean" = "Boolean"

isGlobal

isGlobal: object

serializedName

serializedName: string = "properties.isGlobal"

type

type: object

name

name: "Boolean" = "Boolean"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Created","Creating","StartingImportModuleRunbook","RunningImportModuleRunbook","ContentRetrieved","ContentDownloaded","ContentValidated","ConnectionTypeImported","ContentStored","ModuleDataStored","ActivitiesStored","ModuleImportRunbookComplete","Succeeded","Failed","Cancelled","Updating"]

name

name: "Enum" = "Enum"

sizeInBytes

sizeInBytes: object

serializedName

serializedName: string = "properties.sizeInBytes"

type

type: object

name

name: "Number" = "Number"

version

version: object

serializedName

serializedName: string = "properties.version"

type

type: object

name

name: "String" = "String"

Const ModuleCreateOrUpdateParameters

ModuleCreateOrUpdateParameters: object
interface

An interface representing ModuleCreateOrUpdateParameters. The parameters supplied to the create or update module operation.

contentLink

contentLink: ContentLink
member

{ContentLink} contentLink Gets or sets the module content link.

Optional location

location: undefined | string
member

{string} [location] Gets or sets the location of the resource.

Optional name

name: undefined | string
member

{string} [name] Gets or sets name of the resource.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "ModuleCreateOrUpdateParameters"

type

type: object

className

className: string = "ModuleCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentLink

contentLink: object

required

required: true = true

serializedName

serializedName: string = "properties.contentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const ModuleErrorInfo

ModuleErrorInfo: object
interface

An interface representing ModuleErrorInfo. Definition of the module error info type.

Optional code

code: undefined | string
member

{string} [code] Gets or sets the error code.

Optional message

message: undefined | string
member

{string} [message] Gets or sets the error message.

serializedName

serializedName: string = "ModuleErrorInfo"

type

type: object

className

className: string = "ModuleErrorInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const ModuleListResult

ModuleListResult: object
interface

An interface representing the ModuleListResult. The response model for the list module operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "ModuleListResult"

__@iterator

  • __@iterator(): IterableIterator<Module>
  • Iterator

    Returns IterableIterator<Module>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Module>[]): Module[]
  • concat(...items: (T | ConcatArray<T>)[]): Module[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Module>[]

      Additional items to add to the end of array1.

    Returns Module[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Module[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Module]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Module]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Module, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Module

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Module[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Module[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Module | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Module, index: number, obj: Module[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Module | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Module, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Module

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Module, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Module

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Module, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Module

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Module | undefined

push

  • push(...items: Module[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Module[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Module
  • reduce(callbackfn: function, initialValue: Module): Module
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Module

  • Parameters

    Returns Module

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Module, currentIndex: number, array: Module[]): U
        • Parameters

          • previousValue: U
          • currentValue: Module
          • currentIndex: number
          • array: Module[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Module
  • reduceRight(callbackfn: function, initialValue: Module): Module
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Module

  • Parameters

    Returns Module

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Module, currentIndex: number, array: Module[]): U
        • Parameters

          • previousValue: U
          • currentValue: Module
          • currentIndex: number
          • array: Module[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Module[]

shift

  • Removes the first element from an array and returns it.

    Returns Module | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Module[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Module[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Module[]
  • splice(start: number, deleteCount: number, ...items: Module[]): Module[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Module[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Module[]

      Elements to insert into the array in place of the deleted elements.

    Returns Module[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Module[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Module[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Module>
  • Returns an iterable of values in the array

    Returns IterableIterator<Module>

type

type: object

className

className: string = "ModuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Module"

name

name: "Composite" = "Composite"

Const ModuleUpdateParameters

ModuleUpdateParameters: object
interface

An interface representing ModuleUpdateParameters. The parameters supplied to the update module operation.

Optional contentLink

contentLink: ContentLink
member

{ContentLink} [contentLink] Gets or sets the module content link.

Optional location

location: undefined | string
member

{string} [location] Gets or sets the location of the resource.

Optional name

name: undefined | string
member

{string} [name] Gets or sets name of the resource.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "ModuleUpdateParameters"

type

type: object

className

className: string = "ModuleUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentLink

contentLink: object

serializedName

serializedName: string = "properties.contentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const NodeCount

NodeCount: object
interface

An interface representing NodeCount. Number of nodes based on the Filter

Optional name

name: undefined | string
member

{string} [name] Gets the name of a count type

Optional properties

member

{NodeCountProperties} [properties]

serializedName

serializedName: string = "NodeCount"

type

type: object

className

className: string = "NodeCount"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "NodeCountProperties"

name

name: "Composite" = "Composite"

Const NodeCountProperties

NodeCountProperties: object
interface

An interface representing NodeCountProperties.

Optional count

count: undefined | number
member

{number} [count] Gets the count for the name

serializedName

serializedName: string = "NodeCountProperties"

type

type: object

className

className: string = "NodeCountProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

Const NodeCounts

NodeCounts: object
interface

An interface representing NodeCounts. Gets the count of nodes by count type

Optional totalCount

totalCount: undefined | number
member

{number} [totalCount] Gets the total number of records matching countType criteria.

Optional value

value: NodeCount[]
member

{NodeCount[]} [value] Gets an array of counts

serializedName

serializedName: string = "NodeCounts"

type

type: object

className

className: string = "NodeCounts"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

totalCount

totalCount: object

serializedName

serializedName: string = "totalCount"

type

type: object

name

name: "Number" = "Number"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeCount"

name

name: "Composite" = "Composite"

Const Operation

Operation: object
interface

An interface representing Operation. Automation REST API operation

Optional display

member

{OperationDisplay} [display] Provider, Resource and Operation values

Optional name

name: undefined | string
member

{string} [name] Operation name: {provider}/{resource}/{operation}

serializedName

serializedName: string = "Operation"

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const OperationDisplay

OperationDisplay: object
interface

An interface representing OperationDisplay. Provider, Resource and Operation values

Optional operation

operation: undefined | string
member

{string} [operation] Operation type: Read, write, delete, etc.

Optional provider

provider: undefined | string
member

{string} [provider] Service provider: Microsoft.Automation

Optional resource

resource: undefined | string
member

{string} [resource] Resource on which the operation is performed: Runbooks, Jobs etc.

serializedName

serializedName: string = "Operation_display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OperationListResult

OperationListResult: object
interface

An interface representing the OperationListResult. The response model for the list of Automation operations

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "OperationListResult"

__@iterator

  • Iterator

    Returns IterableIterator<Operation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Operation>[]

      Additional items to add to the end of array1.

    Returns Operation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Operation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Operation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Operation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Operation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Operation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Operation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Operation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Operation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Operation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Operation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Operation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Operation | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Operation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Operation
  • reduce(callbackfn: function, initialValue: Operation): Operation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Operation
  • reduceRight(callbackfn: function, initialValue: Operation): Operation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Operation[]

shift

  • Removes the first element from an array and returns it.

    Returns Operation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Operation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Operation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Operation[]
  • splice(start: number, deleteCount: number, ...items: Operation[]): Operation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Operation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Operation[]

      Elements to insert into the array in place of the deleted elements.

    Returns Operation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Operation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Operation>

type

type: object

className

className: string = "OperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

Const ProxyResource

ProxyResource: object
interface

An interface representing ProxyResource. ARM proxy resource.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProxyResource"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProxyResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

Const PythonPackageCreateParameters

PythonPackageCreateParameters: object
interface

An interface representing PythonPackageCreateParameters. The parameters supplied to the create or update module operation.

contentLink

contentLink: ContentLink
member

{ContentLink} contentLink Gets or sets the module content link.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "PythonPackageCreateParameters"

type

type: object

className

className: string = "PythonPackageCreateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentLink

contentLink: object

required

required: true = true

serializedName

serializedName: string = "properties.contentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const PythonPackageUpdateParameters

PythonPackageUpdateParameters: object
interface

An interface representing PythonPackageUpdateParameters. The parameters supplied to the update module operation.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "PythonPackageUpdateParameters"

type

type: object

className

className: string = "PythonPackageUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const Resource

Resource: object
interface

An interface representing Resource. The core properties of ARM resources

extends

BaseResource

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const RunAsCredentialAssociationProperty

RunAsCredentialAssociationProperty: object
interface

An interface representing RunAsCredentialAssociationProperty. Definition of runas credential to use for hybrid worker.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the credential.

serializedName

serializedName: string = "RunAsCredentialAssociationProperty"

type

type: object

className

className: string = "RunAsCredentialAssociationProperty"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const Runbook

Runbook: object
interface

An interface representing Runbook. Definition of the runbook type.

extends

TrackedResource

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional draft

member

{RunbookDraft} [draft] Gets or sets the draft runbook properties.

Optional etag

etag: undefined | string
member

{string} [etag] Gets or sets the etag of the resource.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobCount

jobCount: undefined | number
member

{number} [jobCount] Gets or sets the job count of the runbook.

Optional lastModifiedBy

lastModifiedBy: undefined | string
member

{string} [lastModifiedBy] Gets or sets the last modified by.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time.

Optional location

location: undefined | string
member

{string} [location] The Azure Region where the resource lives

Optional logActivityTrace

logActivityTrace: undefined | number
member

{number} [logActivityTrace] Gets or sets the option to log activity trace of the runbook.

Optional logProgress

logProgress: undefined | false | true
member

{boolean} [logProgress] Gets or sets progress log option.

Optional logVerbose

logVerbose: undefined | false | true
member

{boolean} [logVerbose] Gets or sets verbose log option.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputTypes

outputTypes: string[]
member

{string[]} [outputTypes] Gets or sets the runbook output types.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: RunbookParameter }} [parameters] Gets or sets the runbook parameters.

Optional provisioningState

provisioningState: RunbookProvisioningState
member

{RunbookProvisioningState} [provisioningState] Gets or sets the provisioning state of the runbook. Possible values include: 'Succeeded'

Optional publishContentLink

publishContentLink: ContentLink
member

{ContentLink} [publishContentLink] Gets or sets the published runbook content link.

Optional runbookType

runbookType: RunbookTypeEnum
member

{RunbookTypeEnum} [runbookType] Gets or sets the type of the runbook. Possible values include: 'Script', 'Graph', 'PowerShellWorkflow', 'PowerShell', 'GraphPowerShellWorkflow', 'GraphPowerShell'

Optional state

member

{RunbookState} [state] Gets or sets the state of the runbook. Possible values include: 'New', 'Edit', 'Published'

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

serializedName

serializedName: string = "Runbook"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Runbook"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

draft

draft: object

serializedName

serializedName: string = "properties.draft"

type

type: object

className

className: string = "RunbookDraft"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

jobCount

jobCount: object

serializedName

serializedName: string = "properties.jobCount"

type

type: object

name

name: "Number" = "Number"

lastModifiedBy

lastModifiedBy: object

serializedName

serializedName: string = "properties.lastModifiedBy"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

logActivityTrace

logActivityTrace: object

serializedName

serializedName: string = "properties.logActivityTrace"

type

type: object

name

name: "Number" = "Number"

logProgress

logProgress: object

serializedName

serializedName: string = "properties.logProgress"

type

type: object

name

name: "Boolean" = "Boolean"

logVerbose

logVerbose: object

serializedName

serializedName: string = "properties.logVerbose"

type

type: object

name

name: "Boolean" = "Boolean"

outputTypes

outputTypes: object

serializedName

serializedName: string = "properties.outputTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "RunbookParameter"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded"]

name

name: "Enum" = "Enum"

publishContentLink

publishContentLink: object

serializedName

serializedName: string = "properties.publishContentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

runbookType

runbookType: object

serializedName

serializedName: string = "properties.runbookType"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const RunbookAssociationProperty

RunbookAssociationProperty: object
interface

An interface representing RunbookAssociationProperty. The runbook property associated with the entity.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the runbook.

serializedName

serializedName: string = "RunbookAssociationProperty"

type

type: object

className

className: string = "RunbookAssociationProperty"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const RunbookCreateOrUpdateDraftParameters

RunbookCreateOrUpdateDraftParameters: object
interface

An interface representing RunbookCreateOrUpdateDraftParameters. The parameters supplied to the create or update runbook operation.

runbookContent

runbookContent: string
member

{string} runbookContent Content of the Runbook.

serializedName

serializedName: string = "RunbookCreateOrUpdateDraftParameters"

type

type: object

className

className: string = "RunbookCreateOrUpdateDraftParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

runbookContent

runbookContent: object

required

required: true = true

serializedName

serializedName: string = "runbookContent"

type

type: object

name

name: "String" = "String"

Const RunbookCreateOrUpdateDraftProperties

RunbookCreateOrUpdateDraftProperties: object
interface

An interface representing RunbookCreateOrUpdateDraftProperties. The parameters supplied to the create or update dratft runbook properties.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the runbook.

draft

member

{RunbookDraft} draft Gets or sets the draft runbook properties.

Optional logActivityTrace

logActivityTrace: undefined | number
member

{number} [logActivityTrace] Gets or sets the activity-level tracing options of the runbook.

Optional logProgress

logProgress: undefined | false | true
member

{boolean} [logProgress] Gets or sets progress log option.

Optional logVerbose

logVerbose: undefined | false | true
member

{boolean} [logVerbose] Gets or sets verbose log option.

runbookType

runbookType: RunbookTypeEnum
member

{RunbookTypeEnum} runbookType Gets or sets the type of the runbook. Possible values include: 'Script', 'Graph', 'PowerShellWorkflow', 'PowerShell', 'GraphPowerShellWorkflow', 'GraphPowerShell'

serializedName

serializedName: string = "RunbookCreateOrUpdateDraftProperties"

type

type: object

className

className: string = "RunbookCreateOrUpdateDraftProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

draft

draft: object

required

required: true = true

serializedName

serializedName: string = "draft"

type

type: object

className

className: string = "RunbookDraft"

name

name: "Composite" = "Composite"

logActivityTrace

logActivityTrace: object

serializedName

serializedName: string = "logActivityTrace"

type

type: object

name

name: "Number" = "Number"

logProgress

logProgress: object

serializedName

serializedName: string = "logProgress"

type

type: object

name

name: "Boolean" = "Boolean"

logVerbose

logVerbose: object

serializedName

serializedName: string = "logVerbose"

type

type: object

name

name: "Boolean" = "Boolean"

runbookType

runbookType: object

required

required: true = true

serializedName

serializedName: string = "runbookType"

type

type: object

name

name: "String" = "String"

Const RunbookCreateOrUpdateParameters

RunbookCreateOrUpdateParameters: object
interface

An interface representing RunbookCreateOrUpdateParameters. The parameters supplied to the create or update runbook operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the runbook.

Optional draft

member

{RunbookDraft} [draft] Gets or sets the draft runbook properties.

Optional location

location: undefined | string
member

{string} [location] Gets or sets the location of the resource.

Optional logActivityTrace

logActivityTrace: undefined | number
member

{number} [logActivityTrace] Gets or sets the activity-level tracing options of the runbook.

Optional logProgress

logProgress: undefined | false | true
member

{boolean} [logProgress] Gets or sets progress log option.

Optional logVerbose

logVerbose: undefined | false | true
member

{boolean} [logVerbose] Gets or sets verbose log option.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the resource.

Optional publishContentLink

publishContentLink: ContentLink
member

{ContentLink} [publishContentLink] Gets or sets the published runbook content link.

runbookType

runbookType: RunbookTypeEnum
member

{RunbookTypeEnum} runbookType Gets or sets the type of the runbook. Possible values include: 'Script', 'Graph', 'PowerShellWorkflow', 'PowerShell', 'GraphPowerShellWorkflow', 'GraphPowerShell'

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "RunbookCreateOrUpdateParameters"

type

type: object

className

className: string = "RunbookCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

draft

draft: object

serializedName

serializedName: string = "properties.draft"

type

type: object

className

className: string = "RunbookDraft"

name

name: "Composite" = "Composite"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

logActivityTrace

logActivityTrace: object

serializedName

serializedName: string = "properties.logActivityTrace"

type

type: object

name

name: "Number" = "Number"

logProgress

logProgress: object

serializedName

serializedName: string = "properties.logProgress"

type

type: object

name

name: "Boolean" = "Boolean"

logVerbose

logVerbose: object

serializedName

serializedName: string = "properties.logVerbose"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

publishContentLink

publishContentLink: object

serializedName

serializedName: string = "properties.publishContentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

runbookType

runbookType: object

required

required: true = true

serializedName

serializedName: string = "properties.runbookType"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const RunbookDraft

RunbookDraft: object
interface

An interface representing RunbookDraft.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time of the runbook draft.

Optional draftContentLink

draftContentLink: ContentLink
member

{ContentLink} [draftContentLink] Gets or sets the draft runbook content link.

Optional inEdit

inEdit: undefined | false | true
member

{boolean} [inEdit] Gets or sets whether runbook is in edit mode.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time of the runbook draft.

Optional outputTypes

outputTypes: string[]
member

{string[]} [outputTypes] Gets or sets the runbook output types.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: RunbookParameter }} [parameters] Gets or sets the runbook draft parameters.

serializedName

serializedName: string = "RunbookDraft"

type

type: object

className

className: string = "RunbookDraft"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

draftContentLink

draftContentLink: object

serializedName

serializedName: string = "draftContentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

inEdit

inEdit: object

serializedName

serializedName: string = "inEdit"

type

type: object

name

name: "Boolean" = "Boolean"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

outputTypes

outputTypes: object

serializedName

serializedName: string = "outputTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "RunbookParameter"

name

name: "Composite" = "Composite"

Const RunbookDraftReplaceContentHeaders

RunbookDraftReplaceContentHeaders: object
interface

An interface representing RunbookDraftReplaceContentHeaders. Defines headers for ReplaceContent operation.

location

location: string
member

{string} [location] URL to query for status of the operation.

serializedName

serializedName: string = "runbookdraft-replacecontent-headers"

type

type: object

className

className: string = "RunbookDraftReplaceContentHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

Const RunbookDraftUndoEditResult

RunbookDraftUndoEditResult: object
interface

An interface representing RunbookDraftUndoEditResult. The response model for the undoedit runbook operation.

Optional requestId

requestId: undefined | string
member

{string} [requestId]

Optional statusCode

statusCode: HttpStatusCode
member

{HttpStatusCode} [statusCode] Possible values include: 'Continue', 'SwitchingProtocols', 'OK', 'Created', 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', 'PartialContent', 'MultipleChoices', 'Ambiguous', 'MovedPermanently', 'Moved', 'Found', 'Redirect', 'SeeOther', 'RedirectMethod', 'NotModified', 'UseProxy', 'Unused', 'TemporaryRedirect', 'RedirectKeepVerb', 'BadRequest', 'Unauthorized', 'PaymentRequired', 'Forbidden', 'NotFound', 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', 'PreconditionFailed', 'RequestEntityTooLarge', 'RequestUriTooLong', 'UnsupportedMediaType', 'RequestedRangeNotSatisfiable', 'ExpectationFailed', 'UpgradeRequired', 'InternalServerError', 'NotImplemented', 'BadGateway', 'ServiceUnavailable', 'GatewayTimeout', 'HttpVersionNotSupported'

serializedName

serializedName: string = "RunbookDraftUndoEditResult"

type

type: object

className

className: string = "RunbookDraftUndoEditResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

requestId

requestId: object

serializedName

serializedName: string = "requestId"

type

type: object

name

name: "String" = "String"

statusCode

statusCode: object

serializedName

serializedName: string = "statusCode"

type

type: object

name

name: "String" = "String"

Const RunbookListResult

RunbookListResult: object
interface

An interface representing the RunbookListResult. The response model for the list runbook operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "RunbookListResult"

__@iterator

  • __@iterator(): IterableIterator<Runbook>
  • Iterator

    Returns IterableIterator<Runbook>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Runbook>[]): Runbook[]
  • concat(...items: (T | ConcatArray<T>)[]): Runbook[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Runbook>[]

      Additional items to add to the end of array1.

    Returns Runbook[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Runbook[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Runbook]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Runbook]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Runbook, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Runbook

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Runbook[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Runbook[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Runbook | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Runbook, index: number, obj: Runbook[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Runbook | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Runbook, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Runbook

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Runbook, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Runbook

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Runbook, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Runbook

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Runbook | undefined

push

  • push(...items: Runbook[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Runbook[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Runbook
  • reduce(callbackfn: function, initialValue: Runbook): Runbook
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Runbook

  • Parameters

    Returns Runbook

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Runbook, currentIndex: number, array: Runbook[]): U
        • Parameters

          • previousValue: U
          • currentValue: Runbook
          • currentIndex: number
          • array: Runbook[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Runbook
  • reduceRight(callbackfn: function, initialValue: Runbook): Runbook
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Runbook

  • Parameters

    Returns Runbook

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Runbook, currentIndex: number, array: Runbook[]): U
        • Parameters

          • previousValue: U
          • currentValue: Runbook
          • currentIndex: number
          • array: Runbook[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Runbook[]

shift

  • Removes the first element from an array and returns it.

    Returns Runbook | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Runbook[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Runbook[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Runbook[]
  • splice(start: number, deleteCount: number, ...items: Runbook[]): Runbook[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Runbook[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Runbook[]

      Elements to insert into the array in place of the deleted elements.

    Returns Runbook[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Runbook[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Runbook[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Runbook>
  • Returns an iterable of values in the array

    Returns IterableIterator<Runbook>

type

type: object

className

className: string = "RunbookListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Runbook"

name

name: "Composite" = "Composite"

Const RunbookParameter

RunbookParameter: object
interface

An interface representing RunbookParameter. Definition of the runbook parameter type.

Optional defaultValue

defaultValue: undefined | string
member

{string} [defaultValue] Gets or sets the default value of parameter.

Optional isMandatory

isMandatory: undefined | false | true
member

{boolean} [isMandatory] Gets or sets a Boolean value to indicate whether the parameter is madatory or not.

Optional position

position: undefined | number
member

{number} [position] Get or sets the position of the parameter.

serializedName

serializedName: string = "RunbookParameter"

Optional type

type: object
member

{string} [type] Gets or sets the type of the parameter.

className

className: string = "RunbookParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultValue

defaultValue: object

serializedName

serializedName: string = "defaultValue"

type

type: object

name

name: "String" = "String"

isMandatory

isMandatory: object

serializedName

serializedName: string = "isMandatory"

type

type: object

name

name: "Boolean" = "Boolean"

position

position: object

serializedName

serializedName: string = "position"

type

type: object

name

name: "Number" = "Number"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const RunbookPublishHeaders

RunbookPublishHeaders: object
interface

An interface representing RunbookPublishHeaders. Defines headers for Publish operation.

location

location: string
member

{string} [location] URL to query for status of the operation.

serializedName

serializedName: string = "runbook-publish-headers"

type

type: object

className

className: string = "RunbookPublishHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

Const RunbookUpdateParameters

RunbookUpdateParameters: object
interface

An interface representing RunbookUpdateParameters. The parameters supplied to the update runbook operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the runbook.

Optional location

location: undefined | string
member

{string} [location] Gets or sets the location of the resource.

Optional logActivityTrace

logActivityTrace: undefined | number
member

{number} [logActivityTrace] Gets or sets the activity-level tracing options of the runbook.

Optional logProgress

logProgress: undefined | false | true
member

{boolean} [logProgress] Gets or sets progress log option.

Optional logVerbose

logVerbose: undefined | false | true
member

{boolean} [logVerbose] Gets or sets verbose log option.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the resource.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Gets or sets the tags attached to the resource.

serializedName

serializedName: string = "RunbookUpdateParameters"

type

type: object

className

className: string = "RunbookUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

logActivityTrace

logActivityTrace: object

serializedName

serializedName: string = "properties.logActivityTrace"

type

type: object

name

name: "Number" = "Number"

logProgress

logProgress: object

serializedName

serializedName: string = "properties.logProgress"

type

type: object

name

name: "Boolean" = "Boolean"

logVerbose

logVerbose: object

serializedName

serializedName: string = "properties.logVerbose"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const Schedule

Schedule: object
interface

An interface representing Schedule. Definition of the schedule.

extends

ProxyResource

Optional advancedSchedule

advancedSchedule: AdvancedSchedule
member

{AdvancedSchedule} [advancedSchedule] Gets or sets the advanced schedule.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional expiryTime

expiryTime: Date
member

{Date} [expiryTime] Gets or sets the end time of the schedule.

Optional expiryTimeOffsetMinutes

expiryTimeOffsetMinutes: undefined | number
member

{number} [expiryTimeOffsetMinutes] Gets or sets the expiry time's offset in minutes.

Optional frequency

member

{ScheduleFrequency} [frequency] Gets or sets the frequency of the schedule. Possible values include: 'OneTime', 'Day', 'Hour', 'Week', 'Month'

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional interval

interval: undefined | number
member

{number} [interval] Gets or sets the interval of the schedule.

Optional isEnabled

isEnabled: undefined | false | true
member

{boolean} [isEnabled] Gets or sets a value indicating whether this schedule is enabled. Default value: false .

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextRun

nextRun: Date
member

{Date} [nextRun] Gets or sets the next run time of the schedule.

Optional nextRunOffsetMinutes

nextRunOffsetMinutes: undefined | number
member

{number} [nextRunOffsetMinutes] Gets or sets the next run time's offset in minutes.

Optional startTime

startTime: Date
member

{Date} [startTime] Gets or sets the start time of the schedule.

Optional startTimeOffsetMinutes

startTimeOffsetMinutes: undefined | number
member

{number} [startTimeOffsetMinutes] Gets the start time's offset in minutes. NOTE: This property will not be serialized. It can only be populated by the server.

Optional timeZone

timeZone: undefined | string
member

{string} [timeZone] Gets or sets the time zone of the schedule.

serializedName

serializedName: string = "Schedule"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

advancedSchedule

advancedSchedule: object

serializedName

serializedName: string = "properties.advancedSchedule"

type

type: object

className

className: string = "AdvancedSchedule"

name

name: "Composite" = "Composite"

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

expiryTime

expiryTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "properties.expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

expiryTimeOffsetMinutes

expiryTimeOffsetMinutes: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.expiryTimeOffsetMinutes"

type

type: object

name

name: "Number" = "Number"

frequency

frequency: object

serializedName

serializedName: string = "properties.frequency"

type

type: object

name

name: "String" = "String"

interval

interval: object

serializedName

serializedName: string = "properties.interval"

type

type: object

name

name: "Number" = "Number"

isEnabled

isEnabled: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.isEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

nextRun

nextRun: object

nullable

nullable: true = true

serializedName

serializedName: string = "properties.nextRun"

type

type: object

name

name: "DateTime" = "DateTime"

nextRunOffsetMinutes

nextRunOffsetMinutes: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.nextRunOffsetMinutes"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

startTimeOffsetMinutes

startTimeOffsetMinutes: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTimeOffsetMinutes"

type

type: object

name

name: "Number" = "Number"

timeZone

timeZone: object

serializedName

serializedName: string = "properties.timeZone"

type

type: object

name

name: "String" = "String"

Const ScheduleAssociationProperty

ScheduleAssociationProperty: object
interface

An interface representing ScheduleAssociationProperty. The schedule property associated with the entity.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the Schedule.

serializedName

serializedName: string = "ScheduleAssociationProperty"

type

type: object

className

className: string = "ScheduleAssociationProperty"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ScheduleCreateOrUpdateParameters

ScheduleCreateOrUpdateParameters: object
interface

An interface representing ScheduleCreateOrUpdateParameters. The parameters supplied to the create or update schedule operation.

Optional advancedSchedule

advancedSchedule: AdvancedSchedule
member

{AdvancedSchedule} [advancedSchedule] Gets or sets the AdvancedSchedule.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the schedule.

Optional expiryTime

expiryTime: Date
member

{Date} [expiryTime] Gets or sets the end time of the schedule.

frequency

member

{ScheduleFrequency} frequency Possible values include: 'OneTime', 'Day', 'Hour', 'Week', 'Month'

Optional interval

interval: any
member

{any} [interval] Gets or sets the interval of the schedule.

name

name: string
member

{string} name Gets or sets the name of the Schedule.

startTime

startTime: Date
member

{Date} startTime Gets or sets the start time of the schedule.

Optional timeZone

timeZone: undefined | string
member

{string} [timeZone] Gets or sets the time zone of the schedule.

serializedName

serializedName: string = "ScheduleCreateOrUpdateParameters"

type

type: object

className

className: string = "ScheduleCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

advancedSchedule

advancedSchedule: object

serializedName

serializedName: string = "properties.advancedSchedule"

type

type: object

className

className: string = "AdvancedSchedule"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

expiryTime

expiryTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "properties.expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

frequency

frequency: object

required

required: true = true

serializedName

serializedName: string = "properties.frequency"

type

type: object

name

name: "String" = "String"

interval

interval: object

serializedName

serializedName: string = "properties.interval"

type

type: object

name

name: "Object" = "Object"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

nullable

nullable: false = false

required

required: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

timeZone

timeZone: object

serializedName

serializedName: string = "properties.timeZone"

type

type: object

name

name: "String" = "String"

Const ScheduleListResult

ScheduleListResult: object
interface

An interface representing the ScheduleListResult. The response model for the list schedule operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "ScheduleListResult"

__@iterator

  • __@iterator(): IterableIterator<Schedule>
  • Iterator

    Returns IterableIterator<Schedule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Schedule>[]

      Additional items to add to the end of array1.

    Returns Schedule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Schedule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Schedule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Schedule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Schedule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Schedule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Schedule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Schedule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Schedule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Schedule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Schedule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Schedule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Schedule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Schedule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Schedule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Schedule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Schedule | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Schedule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Schedule
  • reduce(callbackfn: function, initialValue: Schedule): Schedule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Schedule

  • Parameters

    Returns Schedule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Schedule, currentIndex: number, array: Schedule[]): U
        • Parameters

          • previousValue: U
          • currentValue: Schedule
          • currentIndex: number
          • array: Schedule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Schedule
  • reduceRight(callbackfn: function, initialValue: Schedule): Schedule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Schedule

  • Parameters

    Returns Schedule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Schedule, currentIndex: number, array: Schedule[]): U
        • Parameters

          • previousValue: U
          • currentValue: Schedule
          • currentIndex: number
          • array: Schedule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Schedule[]

shift

  • Removes the first element from an array and returns it.

    Returns Schedule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Schedule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Schedule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Schedule[]
  • splice(start: number, deleteCount: number, ...items: Schedule[]): Schedule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Schedule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Schedule[]

      Elements to insert into the array in place of the deleted elements.

    Returns Schedule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Schedule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Schedule>

type

type: object

className

className: string = "ScheduleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

Const ScheduleProperties

ScheduleProperties: object
interface

An interface representing ScheduleProperties. Definition of schedule parameters.

Optional advancedSchedule

advancedSchedule: AdvancedSchedule
member

{AdvancedSchedule} [advancedSchedule] Gets or sets the advanced schedule.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional expiryTime

expiryTime: Date
member

{Date} [expiryTime] Gets or sets the end time of the schedule.

Optional expiryTimeOffsetMinutes

expiryTimeOffsetMinutes: undefined | number
member

{number} [expiryTimeOffsetMinutes] Gets or sets the expiry time's offset in minutes.

Optional frequency

member

{ScheduleFrequency} [frequency] Gets or sets the frequency of the schedule. Possible values include: 'OneTime', 'Day', 'Hour', 'Week', 'Month'

Optional interval

interval: undefined | number
member

{number} [interval] Gets or sets the interval of the schedule.

Optional isEnabled

isEnabled: undefined | false | true
member

{boolean} [isEnabled] Gets or sets a value indicating whether this schedule is enabled. Default value: false .

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time.

Optional nextRun

nextRun: Date
member

{Date} [nextRun] Gets or sets the next run time of the schedule.

Optional nextRunOffsetMinutes

nextRunOffsetMinutes: undefined | number
member

{number} [nextRunOffsetMinutes] Gets or sets the next run time's offset in minutes.

Optional startTime

startTime: Date
member

{Date} [startTime] Gets or sets the start time of the schedule.

Optional startTimeOffsetMinutes

startTimeOffsetMinutes: undefined | number
member

{number} [startTimeOffsetMinutes] Gets the start time's offset in minutes. NOTE: This property will not be serialized. It can only be populated by the server.

Optional timeZone

timeZone: undefined | string
member

{string} [timeZone] Gets or sets the time zone of the schedule.

serializedName

serializedName: string = "ScheduleProperties"

type

type: object

className

className: string = "ScheduleProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

advancedSchedule

advancedSchedule: object

serializedName

serializedName: string = "advancedSchedule"

type

type: object

className

className: string = "AdvancedSchedule"

name

name: "Composite" = "Composite"

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

expiryTime

expiryTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

expiryTimeOffsetMinutes

expiryTimeOffsetMinutes: object

nullable

nullable: false = false

serializedName

serializedName: string = "expiryTimeOffsetMinutes"

type

type: object

name

name: "Number" = "Number"

frequency

frequency: object

serializedName

serializedName: string = "frequency"

type

type: object

name

name: "String" = "String"

interval

interval: object

serializedName

serializedName: string = "interval"

type

type: object

name

name: "Number" = "Number"

isEnabled

isEnabled: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "isEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

nextRun

nextRun: object

nullable

nullable: true = true

serializedName

serializedName: string = "nextRun"

type

type: object

name

name: "DateTime" = "DateTime"

nextRunOffsetMinutes

nextRunOffsetMinutes: object

nullable

nullable: false = false

serializedName

serializedName: string = "nextRunOffsetMinutes"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

startTimeOffsetMinutes

startTimeOffsetMinutes: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "startTimeOffsetMinutes"

type

type: object

name

name: "Number" = "Number"

timeZone

timeZone: object

serializedName

serializedName: string = "timeZone"

type

type: object

name

name: "String" = "String"

Const ScheduleUpdateParameters

ScheduleUpdateParameters: object
interface

An interface representing ScheduleUpdateParameters. The parameters supplied to the update schedule operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the schedule.

Optional isEnabled

isEnabled: undefined | false | true
member

{boolean} [isEnabled] Gets or sets a value indicating whether this schedule is enabled.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the Schedule.

serializedName

serializedName: string = "ScheduleUpdateParameters"

type

type: object

className

className: string = "ScheduleUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isEnabled

isEnabled: object

serializedName

serializedName: string = "properties.isEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const Sku

Sku: object
interface

An interface representing Sku. The account SKU.

Optional capacity

capacity: undefined | number
member

{number} [capacity] Gets or sets the SKU capacity.

Optional family

family: undefined | string
member

{string} [family] Gets or sets the SKU family.

name

member

{SkuNameEnum} name Gets or sets the SKU name of the account. Possible values include: 'Free', 'Basic'

serializedName

serializedName: string = "Sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacity

capacity: object

serializedName

serializedName: string = "capacity"

type

type: object

name

name: "Number" = "Number"

family

family: object

serializedName

serializedName: string = "family"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const SoftareUpdateConfigurationRunTaskProperties

SoftareUpdateConfigurationRunTaskProperties: object
interface

An interface representing SoftareUpdateConfigurationRunTaskProperties. Task properties of the software update configuration.

Optional jobId

jobId: undefined | string
member

{string} [jobId] The job id of the task.

Optional source

source: undefined | string
member

{string} [source] The name of the source of the task.

Optional status

status: undefined | string
member

{string} [status] The status of the task.

serializedName

serializedName: string = "softareUpdateConfigurationRunTaskProperties"

type

type: object

className

className: string = "SoftareUpdateConfigurationRunTaskProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

jobId

jobId: object

serializedName

serializedName: string = "jobId"

type

type: object

name

name: "String" = "String"

source

source: object

serializedName

serializedName: string = "source"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const SoftareUpdateConfigurationRunTasks

SoftareUpdateConfigurationRunTasks: object
interface

An interface representing SoftareUpdateConfigurationRunTasks. Software update configuration run tasks model.

Optional postTask

member

{SoftareUpdateConfigurationRunTaskProperties} [postTask] Post task properties.

Optional preTask

member

{SoftareUpdateConfigurationRunTaskProperties} [preTask] Pre task properties.

serializedName

serializedName: string = "softareUpdateConfigurationRunTasks"

type

type: object

className

className: string = "SoftareUpdateConfigurationRunTasks"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

postTask

postTask: object

serializedName

serializedName: string = "postTask"

type

type: object

className

className: string = "SoftareUpdateConfigurationRunTaskProperties"

name

name: "Composite" = "Composite"

preTask

preTask: object

serializedName

serializedName: string = "preTask"

type

type: object

className

className: string = "SoftareUpdateConfigurationRunTaskProperties"

name

name: "Composite" = "Composite"

Const SoftwareUpdateConfiguration

SoftwareUpdateConfiguration: object
interface

An interface representing SoftwareUpdateConfiguration. Software update configuration properties.

extends

BaseResource

Optional createdBy

createdBy: undefined | string
member

{string} [createdBy] CreatedBy property, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Creation time of the resource, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional error

member

{ErrorResponse} [error] Details of provisioning error

Optional id

id: undefined | string
member

{string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedBy

lastModifiedBy: undefined | string
member

{string} [lastModifiedBy] LastModifiedBy property, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Last time resource was modified, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string
member

{string} [provisioningState] Provisioning state for the software update configuration, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

scheduleInfo

scheduleInfo: ScheduleProperties
member

{ScheduleProperties} scheduleInfo Schedule information for the Software update configuration

Optional tasks

member

{SoftwareUpdateConfigurationTasks} [tasks] Tasks information for the Software update configuration.

updateConfiguration

updateConfiguration: UpdateConfiguration
member

{UpdateConfiguration} updateConfiguration update specific properties for the Software update configuration

serializedName

serializedName: string = "softwareUpdateConfiguration"

Optional type

type: object
member

{string} [type] Resource type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "SoftwareUpdateConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdBy

createdBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdBy"

type

type: object

name

name: "String" = "String"

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

error

error: object

serializedName

serializedName: string = "properties.error"

type

type: object

className

className: string = "ErrorResponse"

name

name: "Composite" = "Composite"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

lastModifiedBy

lastModifiedBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedBy"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

scheduleInfo

scheduleInfo: object

required

required: true = true

serializedName

serializedName: string = "properties.scheduleInfo"

type

type: object

className

className: string = "ScheduleProperties"

name

name: "Composite" = "Composite"

tasks

tasks: object

serializedName

serializedName: string = "properties.tasks"

type

type: object

className

className: string = "SoftwareUpdateConfigurationTasks"

name

name: "Composite" = "Composite"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

updateConfiguration

updateConfiguration: object

required

required: true = true

serializedName

serializedName: string = "properties.updateConfiguration"

type

type: object

className

className: string = "UpdateConfiguration"

name

name: "Composite" = "Composite"

Const SoftwareUpdateConfigurationCollectionItem

SoftwareUpdateConfigurationCollectionItem: object
interface

An interface representing SoftwareUpdateConfigurationCollectionItem. Software update configuration collection item properties.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Creation time of the software update configuration, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional frequency

member

{ScheduleFrequency} [frequency] execution frequency of the schedule associated with the software update configuration. Possible values include: 'OneTime', 'Day', 'Hour', 'Week', 'Month'

Optional id

id: undefined | string
member

{string} [id] Resource Id of the software update configuration NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Last time software update configuration was modified, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Name of the software update configuration. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextRun

nextRun: Date
member

{Date} [nextRun] ext run time of the update.

Optional provisioningState

provisioningState: undefined | string
member

{string} [provisioningState] Provisioning state for the software update configuration, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date
member

{Date} [startTime] the start time of the update.

Optional updateConfiguration

member

{CollectionItemUpdateConfiguration} [updateConfiguration] Update specific properties of the software update configuration.

serializedName

serializedName: string = "softwareUpdateConfigurationCollectionItem"

type

type: object

className

className: string = "SoftwareUpdateConfigurationCollectionItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

frequency

frequency: object

serializedName

serializedName: string = "properties.frequency"

type

type: object

name

name: "String" = "String"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

nextRun

nextRun: object

nullable

nullable: true = true

serializedName

serializedName: string = "properties.nextRun"

type

type: object

name

name: "DateTime" = "DateTime"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

updateConfiguration

updateConfiguration: object

serializedName

serializedName: string = "properties.updateConfiguration"

type

type: object

className

className: string = "CollectionItemUpdateConfiguration"

name

name: "Composite" = "Composite"

Const SoftwareUpdateConfigurationListResult

SoftwareUpdateConfigurationListResult: object
interface

An interface representing SoftwareUpdateConfigurationListResult. result of listing all software update configuration

Optional value

member

{SoftwareUpdateConfigurationCollectionItem[]} [value] outer object returned when listing all software update configurations

serializedName

serializedName: string = "softwareUpdateConfigurationListResult"

type

type: object

className

className: string = "SoftwareUpdateConfigurationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SoftwareUpdateConfigurationCollectionItem"

name

name: "Composite" = "Composite"

Const SoftwareUpdateConfigurationMachineRun

SoftwareUpdateConfigurationMachineRun: object
interface

An interface representing SoftwareUpdateConfigurationMachineRun. Software update configuration machine run model.

Optional configuredDuration

configuredDuration: undefined | string
member

{string} [configuredDuration] configured duration for the software update configuration run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional correlationId

correlationId: undefined | string
member

{string} [correlationId] correlation id of the software update configuration machine run NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdBy

createdBy: undefined | string
member

{string} [createdBy] createdBy property, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Creation time of theresource, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date
member

{Date} [endTime] End time of the software update configuration machine run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional error

member

{ErrorResponse} [error] detailes of provisioning error

Optional id

id: undefined | string
member

{string} [id] Resource Id of the software update configuration machine run NOTE: This property will not be serialized. It can only be populated by the server.

Optional job

member

{JobNavigation} [job] Job associated with the software update configuration machine run

Optional lastModifiedBy

lastModifiedBy: undefined | string
member

{string} [lastModifiedBy] lastModifiedBy property, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Last time resource was modified, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Name of the software update configuration machine run NOTE: This property will not be serialized. It can only be populated by the server.

Optional osType

osType: undefined | string
member

{string} [osType] Operating system target of the software update configuration triggered this run NOTE: This property will not be serialized. It can only be populated by the server.

Optional softwareUpdateConfiguration

softwareUpdateConfiguration: UpdateConfigurationNavigation
member

{UpdateConfigurationNavigation} [softwareUpdateConfiguration] software update configuration triggered this run

Optional sourceComputerId

sourceComputerId: undefined | string
member

{string} [sourceComputerId] source computer id of the software update configuration machine run NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date
member

{Date} [startTime] Start time of the software update configuration machine run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: undefined | string
member

{string} [status] Status of the software update configuration machine run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional targetComputer

targetComputer: undefined | string
member

{string} [targetComputer] name of the updated computer NOTE: This property will not be serialized. It can only be populated by the server.

Optional targetComputerType

targetComputerType: undefined | string
member

{string} [targetComputerType] type of the updated computer. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "softwareUpdateConfigurationMachineRun"

type

type: object

className

className: string = "SoftwareUpdateConfigurationMachineRun"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

configuredDuration

configuredDuration: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.configuredDuration"

type

type: object

name

name: "String" = "String"

correlationId

correlationId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.correlationId"

type

type: object

name

name: "Uuid" = "Uuid"

createdBy

createdBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdBy"

type

type: object

name

name: "String" = "String"

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

endTime

endTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

error

error: object

serializedName

serializedName: string = "properties.error"

type

type: object

className

className: string = "ErrorResponse"

name

name: "Composite" = "Composite"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

job

job: object

serializedName

serializedName: string = "properties.job"

type

type: object

className

className: string = "JobNavigation"

name

name: "Composite" = "Composite"

lastModifiedBy

lastModifiedBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedBy"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

osType

osType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.osType"

type

type: object

name

name: "String" = "String"

softwareUpdateConfiguration

softwareUpdateConfiguration: object

serializedName

serializedName: string = "properties.softwareUpdateConfiguration"

type

type: object

className

className: string = "UpdateConfigurationNavigation"

name

name: "Composite" = "Composite"

sourceComputerId

sourceComputerId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.sourceComputerId"

type

type: object

name

name: "Uuid" = "Uuid"

startTime

startTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

targetComputer

targetComputer: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.targetComputer"

type

type: object

name

name: "String" = "String"

targetComputerType

targetComputerType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.targetComputerType"

type

type: object

name

name: "String" = "String"

Const SoftwareUpdateConfigurationMachineRunListResult

SoftwareUpdateConfigurationMachineRunListResult: object
interface

An interface representing SoftwareUpdateConfigurationMachineRunListResult. result of listing all software update configuration machine runs

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] link to next page of results.

Optional value

member

{SoftwareUpdateConfigurationMachineRun[]} [value] outer object returned when listing all software update configuration machine runs

serializedName

serializedName: string = "softwareUpdateConfigurationMachineRunListResult"

type

type: object

className

className: string = "SoftwareUpdateConfigurationMachineRunListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SoftwareUpdateConfigurationMachineRun"

name

name: "Composite" = "Composite"

Const SoftwareUpdateConfigurationRun

SoftwareUpdateConfigurationRun: object
interface

An interface representing SoftwareUpdateConfigurationRun. Software update configuration Run properties.

Optional computerCount

computerCount: undefined | number
member

{number} [computerCount] Number of computers in the software update configuration run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional configuredDuration

configuredDuration: undefined | string
member

{string} [configuredDuration] Configured duration for the software update configuration run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdBy

createdBy: undefined | string
member

{string} [createdBy] CreatedBy property, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Creation time of theresource, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date
member

{Date} [endTime] End time of the software update configuration run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional failedCount

failedCount: undefined | number
member

{number} [failedCount] Number of computers with failed status. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] Resource Id of the software update configuration run NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedBy

lastModifiedBy: undefined | string
member

{string} [lastModifiedBy] LastModifiedBy property, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Last time resource was modified, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Name of the software update configuration run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional osType

osType: undefined | string
member

{string} [osType] Operating system target of the software update configuration triggered this run NOTE: This property will not be serialized. It can only be populated by the server.

Optional softwareUpdateConfiguration

softwareUpdateConfiguration: UpdateConfigurationNavigation
member

{UpdateConfigurationNavigation} [softwareUpdateConfiguration] software update configuration triggered this run

Optional startTime

startTime: Date
member

{Date} [startTime] Start time of the software update configuration run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: undefined | string
member

{string} [status] Status of the software update configuration run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tasks

member

{SoftareUpdateConfigurationRunTasks} [tasks] Software update configuration tasks triggered in this run

serializedName

serializedName: string = "softwareUpdateConfigurationRun"

type

type: object

className

className: string = "SoftwareUpdateConfigurationRun"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

computerCount

computerCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.computerCount"

type

type: object

name

name: "Number" = "Number"

configuredDuration

configuredDuration: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.configuredDuration"

type

type: object

name

name: "String" = "String"

createdBy

createdBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdBy"

type

type: object

name

name: "String" = "String"

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

endTime

endTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

failedCount

failedCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.failedCount"

type

type: object

name

name: "Number" = "Number"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

lastModifiedBy

lastModifiedBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedBy"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

osType

osType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.osType"

type

type: object

name

name: "String" = "String"

softwareUpdateConfiguration

softwareUpdateConfiguration: object

serializedName

serializedName: string = "properties.softwareUpdateConfiguration"

type

type: object

className

className: string = "UpdateConfigurationNavigation"

name

name: "Composite" = "Composite"

startTime

startTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

tasks

tasks: object

serializedName

serializedName: string = "properties.tasks"

type

type: object

className

className: string = "SoftareUpdateConfigurationRunTasks"

name

name: "Composite" = "Composite"

Const SoftwareUpdateConfigurationRunListResult

SoftwareUpdateConfigurationRunListResult: object
interface

An interface representing SoftwareUpdateConfigurationRunListResult. result of listing all software update configuration runs

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] link to next page of results.

Optional value

member

{SoftwareUpdateConfigurationRun[]} [value] outer object returned when listing all software update configuration runs

serializedName

serializedName: string = "softwareUpdateConfigurationRunListResult"

type

type: object

className

className: string = "SoftwareUpdateConfigurationRunListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SoftwareUpdateConfigurationRun"

name

name: "Composite" = "Composite"

Const SoftwareUpdateConfigurationTasks

SoftwareUpdateConfigurationTasks: object
interface

An interface representing SoftwareUpdateConfigurationTasks. Task properties of the software update configuration.

Optional postTask

postTask: TaskProperties
member

{TaskProperties} [postTask] Post task properties.

Optional preTask

member

{TaskProperties} [preTask] Pre task properties.

serializedName

serializedName: string = "softwareUpdateConfigurationTasks"

type

type: object

className

className: string = "SoftwareUpdateConfigurationTasks"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

postTask

postTask: object

serializedName

serializedName: string = "postTask"

type

type: object

className

className: string = "TaskProperties"

name

name: "Composite" = "Composite"

preTask

preTask: object

serializedName

serializedName: string = "preTask"

type

type: object

className

className: string = "TaskProperties"

name

name: "Composite" = "Composite"

Const SourceControl

SourceControl: object
interface

An interface representing SourceControl. Definition of the source control.

extends

ProxyResource

Optional autoSync

autoSync: undefined | false | true
member

{boolean} [autoSync] The auto sync of the source control. Default is false.

Optional branch

branch: undefined | string
member

{string} [branch] The repo branch of the source control. Include branch as empty string for VsoTfvc.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] The creation time.

Optional description

description: undefined | string
member

{string} [description] The description.

Optional folderPath

folderPath: undefined | string
member

{string} [folderPath] The folder path of the source control.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] The last modified time.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional publishRunbook

publishRunbook: undefined | false | true
member

{boolean} [publishRunbook] The auto publish of the source control. Default is true.

Optional repoUrl

repoUrl: undefined | string
member

{string} [repoUrl] The repo url of the source control.

Optional sourceType

sourceType: SourceType
member

{SourceType} [sourceType] The source type. Must be one of VsoGit, VsoTfvc, GitHub. Possible values include: 'VsoGit', 'VsoTfvc', 'GitHub'

serializedName

serializedName: string = "SourceControl"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "SourceControl"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoSync

autoSync: object

serializedName

serializedName: string = "properties.autoSync"

type

type: object

name

name: "Boolean" = "Boolean"

branch

branch: object

serializedName

serializedName: string = "properties.branch"

type

type: object

name

name: "String" = "String"

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

folderPath

folderPath: object

serializedName

serializedName: string = "properties.folderPath"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

publishRunbook

publishRunbook: object

serializedName

serializedName: string = "properties.publishRunbook"

type

type: object

name

name: "Boolean" = "Boolean"

repoUrl

repoUrl: object

serializedName

serializedName: string = "properties.repoUrl"

type

type: object

name

name: "String" = "String"

sourceType

sourceType: object

serializedName

serializedName: string = "properties.sourceType"

type

type: object

name

name: "String" = "String"

Const SourceControlCreateOrUpdateParameters

SourceControlCreateOrUpdateParameters: object
interface

An interface representing SourceControlCreateOrUpdateParameters. The parameters supplied to the create or update source control operation.

Optional autoSync

autoSync: undefined | false | true
member

{boolean} [autoSync] The auto async of the source control. Default is false.

Optional branch

branch: undefined | string
member

{string} [branch] The repo branch of the source control. Include branch as empty string for VsoTfvc.

Optional description

description: undefined | string
member

{string} [description] The user description of the source control.

Optional folderPath

folderPath: undefined | string
member

{string} [folderPath] The folder path of the source control. Path must be relative.

Optional publishRunbook

publishRunbook: undefined | false | true
member

{boolean} [publishRunbook] The auto publish of the source control. Default is true.

Optional repoUrl

repoUrl: undefined | string
member

{string} [repoUrl] The repo url of the source control.

Optional securityToken

member

{SourceControlSecurityTokenProperties} [securityToken] The authorization token for the repo of the source control.

Optional sourceType

sourceType: SourceType
member

{SourceType} [sourceType] The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive. Possible values include: 'VsoGit', 'VsoTfvc', 'GitHub'

serializedName

serializedName: string = "SourceControlCreateOrUpdateParameters"

type

type: object

className

className: string = "SourceControlCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoSync

autoSync: object

serializedName

serializedName: string = "properties.autoSync"

type

type: object

name

name: "Boolean" = "Boolean"

branch

branch: object

serializedName

serializedName: string = "properties.branch"

constraints

constraints: object

MaxLength

MaxLength: number = 255

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 512

type

type: object

name

name: "String" = "String"

folderPath

folderPath: object

serializedName

serializedName: string = "properties.folderPath"

constraints

constraints: object

MaxLength

MaxLength: number = 255

type

type: object

name

name: "String" = "String"

publishRunbook

publishRunbook: object

serializedName

serializedName: string = "properties.publishRunbook"

type

type: object

name

name: "Boolean" = "Boolean"

repoUrl

repoUrl: object

serializedName

serializedName: string = "properties.repoUrl"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

type

type: object

name

name: "String" = "String"

securityToken

securityToken: object

serializedName

serializedName: string = "properties.securityToken"

type

type: object

className

className: string = "SourceControlSecurityTokenProperties"

name

name: "Composite" = "Composite"

sourceType

sourceType: object

serializedName

serializedName: string = "properties.sourceType"

type

type: object

name

name: "String" = "String"

Const SourceControlListResult

SourceControlListResult: object
interface

An interface representing the SourceControlListResult. The response model for the list source controls operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The next link.

serializedName

serializedName: string = "SourceControlListResult"

__@iterator

  • Iterator

    Returns IterableIterator<SourceControl>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SourceControl>[]

      Additional items to add to the end of array1.

    Returns SourceControl[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SourceControl[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SourceControl]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SourceControl, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SourceControl

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SourceControl[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SourceControl[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SourceControl | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns SourceControl | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SourceControl, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SourceControl

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SourceControl, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SourceControl

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SourceControl, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SourceControl

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns SourceControl | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns SourceControl

  • Parameters

    Returns SourceControl

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns SourceControl

  • Parameters

    Returns SourceControl

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns SourceControl[]

shift

  • Removes the first element from an array and returns it.

    Returns SourceControl | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SourceControl[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SourceControl[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SourceControl[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SourceControl[]

      Elements to insert into the array in place of the deleted elements.

    Returns SourceControl[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SourceControl[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<SourceControl>

type

type: object

className

className: string = "SourceControlListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SourceControl"

name

name: "Composite" = "Composite"

Const SourceControlSecurityTokenProperties

SourceControlSecurityTokenProperties: object
interface

An interface representing SourceControlSecurityTokenProperties.

Optional accessToken

accessToken: undefined | string
member

{string} [accessToken] The access token.

Optional refreshToken

refreshToken: undefined | string
member

{string} [refreshToken] The refresh token.

Optional tokenType

tokenType: TokenType
member

{TokenType} [tokenType] The token type. Must be either PersonalAccessToken or Oauth. Possible values include: 'PersonalAccessToken', 'Oauth'

serializedName

serializedName: string = "SourceControlSecurityTokenProperties"

type

type: object

className

className: string = "SourceControlSecurityTokenProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessToken

accessToken: object

serializedName

serializedName: string = "accessToken"

constraints

constraints: object

MaxLength

MaxLength: number = 1024

type

type: object

name

name: "String" = "String"

refreshToken

refreshToken: object

serializedName

serializedName: string = "refreshToken"

constraints

constraints: object

MaxLength

MaxLength: number = 1024

type

type: object

name

name: "String" = "String"

tokenType

tokenType: object

serializedName

serializedName: string = "tokenType"

type

type: object

name

name: "String" = "String"

Const SourceControlSyncJob

SourceControlSyncJob: object
interface

An interface representing SourceControlSyncJob. Definition of the source control sync job.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] The creation time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] Resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState
member

{ProvisioningState} [provisioningState] The provisioning state of the job. Possible values include: 'Completed', 'Failed', 'Running'

Optional sourceControlSyncJobId

sourceControlSyncJobId: undefined | string
member

{string} [sourceControlSyncJobId] The source control sync job id.

Optional startTime

startTime: Date
member

{Date} [startTime] The start time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional syncType

syncType: SyncType
member

{SyncType} [syncType] The sync type. Possible values include: 'PartialSync', 'FullSync'

serializedName

serializedName: string = "SourceControlSyncJob"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "SourceControlSyncJob"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

endTime

endTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

sourceControlSyncJobId

sourceControlSyncJobId: object

serializedName

serializedName: string = "properties.sourceControlSyncJobId"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

syncType

syncType: object

serializedName

serializedName: string = "properties.syncType"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const SourceControlSyncJobById

SourceControlSyncJobById: object
interface

An interface representing SourceControlSyncJobById. Definition of the source control sync job.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] The creation time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional exception

exception: undefined | string
member

{string} [exception] The exceptions that occured while running the sync job.

Optional id

id: undefined | string
member

{string} [id] The id of the job.

Optional provisioningState

provisioningState: ProvisioningState
member

{ProvisioningState} [provisioningState] The provisioning state of the job. Possible values include: 'Completed', 'Failed', 'Running'

Optional sourceControlSyncJobId

sourceControlSyncJobId: undefined | string
member

{string} [sourceControlSyncJobId] The source control sync job id.

Optional startTime

startTime: Date
member

{Date} [startTime] The start time of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Optional syncType

syncType: SyncType
member

{SyncType} [syncType] The sync type. Possible values include: 'PartialSync', 'FullSync'

serializedName

serializedName: string = "SourceControlSyncJobById"

type

type: object

className

className: string = "SourceControlSyncJobById"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

endTime

endTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

exception

exception: object

serializedName

serializedName: string = "properties.exception"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

sourceControlSyncJobId

sourceControlSyncJobId: object

serializedName

serializedName: string = "properties.sourceControlSyncJobId"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

syncType

syncType: object

serializedName

serializedName: string = "properties.syncType"

type

type: object

name

name: "String" = "String"

Const SourceControlSyncJobCreateParameters

SourceControlSyncJobCreateParameters: object
interface

An interface representing SourceControlSyncJobCreateParameters. The parameters supplied to the create source control sync job operation.

commitId

commitId: string
member

{string} commitId The commit id of the source control sync job. If not syncing to a commitId, enter an empty string.

serializedName

serializedName: string = "SourceControlSyncJobCreateParameters"

type

type: object

className

className: string = "SourceControlSyncJobCreateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

commitId

commitId: object

required

required: true = true

serializedName

serializedName: string = "properties.commitId"

constraints

constraints: object

MinLength

MinLength: number = 0

type

type: object

name

name: "String" = "String"

Const SourceControlSyncJobListResult

SourceControlSyncJobListResult: object
interface

An interface representing the SourceControlSyncJobListResult. The response model for the list source control sync jobs operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The next link.

serializedName

serializedName: string = "SourceControlSyncJobListResult"

__@iterator

  • Iterator

    Returns IterableIterator<SourceControlSyncJob>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns SourceControlSyncJob[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SourceControlSyncJob[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SourceControlSyncJob]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SourceControlSyncJob

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SourceControlSyncJob[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SourceControlSyncJob[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SourceControlSyncJob | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns SourceControlSyncJob | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SourceControlSyncJob

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SourceControlSyncJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SourceControlSyncJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns SourceControlSyncJob | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns SourceControlSyncJob

  • Parameters

    Returns SourceControlSyncJob

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns SourceControlSyncJob

  • Parameters

    Returns SourceControlSyncJob

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns SourceControlSyncJob[]

shift

  • Removes the first element from an array and returns it.

    Returns SourceControlSyncJob | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SourceControlSyncJob[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SourceControlSyncJob[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SourceControlSyncJob[]

      Elements to insert into the array in place of the deleted elements.

    Returns SourceControlSyncJob[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<SourceControlSyncJob>

type

type: object

className

className: string = "SourceControlSyncJobListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SourceControlSyncJob"

name

name: "Composite" = "Composite"

Const SourceControlSyncJobStream

SourceControlSyncJobStream: object
interface

An interface representing SourceControlSyncJobStream. Definition of the source control sync job stream.

Optional id

id: undefined | string
member

{string} [id] Resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sourceControlSyncJobStreamId

sourceControlSyncJobStreamId: undefined | string
member

{string} [sourceControlSyncJobStreamId] The sync job stream id.

Optional streamType

streamType: StreamType
member

{StreamType} [streamType] The type of the sync job stream. Possible values include: 'Error', 'Output'

Optional summary

summary: undefined | string
member

{string} [summary] The summary of the sync job stream.

Optional time

time: Date
member

{Date} [time] The time of the sync job stream. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SourceControlSyncJobStream"

type

type: object

className

className: string = "SourceControlSyncJobStream"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

sourceControlSyncJobStreamId

sourceControlSyncJobStreamId: object

serializedName

serializedName: string = "properties.sourceControlSyncJobStreamId"

type

type: object

name

name: "String" = "String"

streamType

streamType: object

serializedName

serializedName: string = "properties.streamType"

type

type: object

name

name: "String" = "String"

summary

summary: object

serializedName

serializedName: string = "properties.summary"

type

type: object

name

name: "String" = "String"

time

time: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.time"

type

type: object

name

name: "DateTime" = "DateTime"

Const SourceControlSyncJobStreamById

SourceControlSyncJobStreamById: object
interface

An interface representing SourceControlSyncJobStreamById. Definition of the source control sync job stream by id.

Optional id

id: undefined | string
member

{string} [id] Resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sourceControlSyncJobStreamId

sourceControlSyncJobStreamId: undefined | string
member

{string} [sourceControlSyncJobStreamId] The sync job stream id.

Optional streamText

streamText: undefined | string
member

{string} [streamText] The text of the sync job stream.

Optional streamType

streamType: StreamType
member

{StreamType} [streamType] The type of the sync job stream. Possible values include: 'Error', 'Output'

Optional summary

summary: undefined | string
member

{string} [summary] The summary of the sync job stream.

Optional time

time: Date
member

{Date} [time] The time of the sync job stream. NOTE: This property will not be serialized. It can only be populated by the server.

Optional value

value: undefined | object
member

{{ [propertyName: string]: any }} [value] The values of the job stream.

serializedName

serializedName: string = "SourceControlSyncJobStreamById"

type

type: object

className

className: string = "SourceControlSyncJobStreamById"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

sourceControlSyncJobStreamId

sourceControlSyncJobStreamId: object

serializedName

serializedName: string = "properties.sourceControlSyncJobStreamId"

type

type: object

name

name: "String" = "String"

streamText

streamText: object

serializedName

serializedName: string = "properties.streamText"

type

type: object

name

name: "String" = "String"

streamType

streamType: object

serializedName

serializedName: string = "properties.streamType"

type

type: object

name

name: "String" = "String"

summary

summary: object

serializedName

serializedName: string = "properties.summary"

type

type: object

name

name: "String" = "String"

time

time: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.time"

type

type: object

name

name: "DateTime" = "DateTime"

value

value: object

serializedName

serializedName: string = "properties.value"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

Const SourceControlSyncJobStreamsListBySyncJob

SourceControlSyncJobStreamsListBySyncJob: object
interface

An interface representing the SourceControlSyncJobStreamsListBySyncJob. The response model for the list source control sync job streams operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The next link. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SourceControlSyncJobStreamsListBySyncJob"

__@iterator

  • Iterator

    Returns IterableIterator<SourceControlSyncJobStream>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns SourceControlSyncJobStream[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SourceControlSyncJobStream[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SourceControlSyncJobStream]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SourceControlSyncJobStream

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns SourceControlSyncJobStream[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SourceControlSyncJobStream | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns SourceControlSyncJobStream | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SourceControlSyncJobStream

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SourceControlSyncJobStream

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SourceControlSyncJobStream

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns SourceControlSyncJobStream | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns SourceControlSyncJobStream[]

shift

  • Removes the first element from an array and returns it.

    Returns SourceControlSyncJobStream | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SourceControlSyncJobStream[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SourceControlSyncJobStream[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SourceControlSyncJobStream[]

      Elements to insert into the array in place of the deleted elements.

    Returns SourceControlSyncJobStream[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<SourceControlSyncJobStream>

type

type: object

className

className: string = "SourceControlSyncJobStreamsListBySyncJob"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SourceControlSyncJobStream"

name

name: "Composite" = "Composite"

Const SourceControlUpdateParameters

SourceControlUpdateParameters: object
interface

An interface representing SourceControlUpdateParameters. The parameters supplied to the update source control operation.

Optional autoSync

autoSync: undefined | false | true
member

{boolean} [autoSync] The auto sync of the source control. Default is false.

Optional branch

branch: undefined | string
member

{string} [branch] The repo branch of the source control.

Optional description

description: undefined | string
member

{string} [description] The user description of the source control.

Optional folderPath

folderPath: undefined | string
member

{string} [folderPath] The folder path of the source control. Path must be relative.

Optional publishRunbook

publishRunbook: undefined | false | true
member

{boolean} [publishRunbook] The auto publish of the source control. Default is true.

Optional securityToken

member

{SourceControlSecurityTokenProperties} [securityToken] The authorization token for the repo of the source control.

serializedName

serializedName: string = "SourceControlUpdateParameters"

type

type: object

className

className: string = "SourceControlUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoSync

autoSync: object

serializedName

serializedName: string = "properties.autoSync"

type

type: object

name

name: "Boolean" = "Boolean"

branch

branch: object

serializedName

serializedName: string = "properties.branch"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

folderPath

folderPath: object

serializedName

serializedName: string = "properties.folderPath"

type

type: object

name

name: "String" = "String"

publishRunbook

publishRunbook: object

serializedName

serializedName: string = "properties.publishRunbook"

type

type: object

name

name: "Boolean" = "Boolean"

securityToken

securityToken: object

serializedName

serializedName: string = "properties.securityToken"

type

type: object

className

className: string = "SourceControlSecurityTokenProperties"

name

name: "Composite" = "Composite"

Const Statistics

Statistics: object
interface

An interface representing Statistics. Definition of the statistic.

Optional counterProperty

counterProperty: undefined | string
member

{string} [counterProperty] Gets the property value of the statistic. NOTE: This property will not be serialized. It can only be populated by the server.

Optional counterValue

counterValue: undefined | number
member

{number} [counterValue] Gets the value of the statistic. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date
member

{Date} [endTime] Gets the endTime of the statistic. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] Gets the id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date
member

{Date} [startTime] Gets the startTime of the statistic. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Statistics"

type

type: object

className

className: string = "Statistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

counterProperty

counterProperty: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "counterProperty"

type

type: object

name

name: "String" = "String"

counterValue

counterValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "counterValue"

type

type: object

name

name: "Number" = "Number"

endTime

endTime: object

nullable

nullable: true = true

readOnly

readOnly: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const StatisticsListResult

StatisticsListResult: object
interface

An interface representing the StatisticsListResult. The response model for the list statistics operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "StatisticsListResult"

__@iterator

  • Iterator

    Returns IterableIterator<Statistics>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Statistics>[]

      Additional items to add to the end of array1.

    Returns Statistics[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Statistics[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Statistics]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Statistics]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Statistics, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Statistics

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Statistics[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Statistics[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Statistics | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Statistics | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Statistics, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Statistics

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Statistics, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Statistics

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Statistics, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Statistics

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Statistics | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Statistics[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Statistics
  • reduce(callbackfn: function, initialValue: Statistics): Statistics
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Statistics

  • Parameters

    Returns Statistics

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Statistics
  • reduceRight(callbackfn: function, initialValue: Statistics): Statistics
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Statistics

  • Parameters

    Returns Statistics

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Statistics[]

shift

  • Removes the first element from an array and returns it.

    Returns Statistics | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Statistics[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Statistics[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Statistics[]
  • splice(start: number, deleteCount: number, ...items: Statistics[]): Statistics[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Statistics[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Statistics[]

      Elements to insert into the array in place of the deleted elements.

    Returns Statistics[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Statistics[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Statistics>

type

type: object

className

className: string = "StatisticsListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Statistics"

name

name: "Composite" = "Composite"

Const TagSettingsProperties

TagSettingsProperties: object
interface

An interface representing TagSettingsProperties. Tag filter information for the VM.

Optional filterOperator

filterOperator: TagOperators
member

{TagOperators} [filterOperator] Filter VMs by Any or All specified tags. Possible values include: 'All', 'Any'

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string[] }} [tags] Dictionary of tags with its list of values.

serializedName

serializedName: string = "TagSettingsProperties"

type

type: object

className

className: string = "TagSettingsProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

filterOperator

filterOperator: object

serializedName

serializedName: string = "filterOperator"

type

type: object

allowedValues

allowedValues: string[] = ["All","Any"]

name

name: "Enum" = "Enum"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const TargetProperties

TargetProperties: object
interface

An interface representing TargetProperties. Group specific to the update configuration.

Optional azureQueries

azureQueries: AzureQueryProperties[]
member

{AzureQueryProperties[]} [azureQueries] List of Azure queries in the software update configuration.

serializedName

serializedName: string = "TargetProperties"

type

type: object

className

className: string = "TargetProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureQueries

azureQueries: object

serializedName

serializedName: string = "azureQueries"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureQueryProperties"

name

name: "Composite" = "Composite"

Const TaskProperties

TaskProperties: object
interface

An interface representing TaskProperties. Task properties of the software update configuration.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the task.

Optional source

source: undefined | string
member

{string} [source] Gets or sets the name of the runbook.

serializedName

serializedName: string = "taskProperties"

type

type: object

className

className: string = "TaskProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

source

source: object

serializedName

serializedName: string = "source"

type

type: object

name

name: "String" = "String"

Const TestJob

TestJob: object
interface

An interface representing TestJob. Definition of the test job.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time of the test job.

Optional endTime

endTime: Date
member

{Date} [endTime] Gets or sets the end time of the test job.

Optional exception

exception: undefined | string
member

{string} [exception] Gets or sets the exception of the test job.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time of the test job.

Optional lastStatusModifiedTime

lastStatusModifiedTime: Date
member

{Date} [lastStatusModifiedTime] Gets or sets the last status modified time of the test job.

Optional logActivityTrace

logActivityTrace: undefined | number
member

{number} [logActivityTrace] The activity-level tracing options of the runbook.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the test job.

Optional runOn

runOn: undefined | string
member

{string} [runOn] Gets or sets the runOn which specifies the group name where the job is to be executed.

Optional startTime

startTime: Date
member

{Date} [startTime] Gets or sets the start time of the test job.

Optional status

status: undefined | string
member

{string} [status] Gets or sets the status of the test job.

Optional statusDetails

statusDetails: undefined | string
member

{string} [statusDetails] Gets or sets the status details of the test job.

serializedName

serializedName: string = "TestJob"

type

type: object

className

className: string = "TestJob"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

endTime

endTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

exception

exception: object

serializedName

serializedName: string = "exception"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastStatusModifiedTime

lastStatusModifiedTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "lastStatusModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

logActivityTrace

logActivityTrace: object

serializedName

serializedName: string = "logActivityTrace"

type

type: object

name

name: "Number" = "Number"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "runOn"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

statusDetails

statusDetails: object

serializedName

serializedName: string = "statusDetails"

type

type: object

name

name: "String" = "String"

Const TestJobCreateParameters

TestJobCreateParameters: object
interface

An interface representing TestJobCreateParameters. The parameters supplied to the create test job operation.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the test job.

Optional runOn

runOn: undefined | string
member

{string} [runOn] Gets or sets the runOn which specifies the group name where the job is to be executed.

serializedName

serializedName: string = "TestJobCreateParameters"

type

type: object

className

className: string = "TestJobCreateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "runOn"

type

type: object

name

name: "String" = "String"

Const TrackedResource

TrackedResource: object
interface

An interface representing TrackedResource. The resource model definition for a ARM tracked top level resource

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] The Azure Region where the resource lives

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

serializedName

serializedName: string = "TrackedResource"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "TrackedResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const TypeField

TypeField: object
interface

An interface representing TypeField. Information about a field of a type.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the field.

serializedName

serializedName: string = "TypeField"

Optional type

type: object
member

{string} [type] Gets or sets the type of the field.

className

className: string = "TypeField"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const TypeFieldListResult

TypeFieldListResult: object
interface

An interface representing the TypeFieldListResult. The response model for the list fields operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "TypeFieldListResult"

__@iterator

  • Iterator

    Returns IterableIterator<TypeField>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<TypeField>[]

      Additional items to add to the end of array1.

    Returns TypeField[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns TypeField[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, TypeField]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, TypeField]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: TypeField, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: TypeField

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): TypeField[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns TypeField[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): TypeField | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns TypeField | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: TypeField, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: TypeField

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: TypeField, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: TypeField

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: TypeField, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: TypeField

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns TypeField | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: TypeField[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): TypeField
  • reduce(callbackfn: function, initialValue: TypeField): TypeField
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns TypeField

  • Parameters

    Returns TypeField

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: TypeField, currentIndex: number, array: TypeField[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): TypeField
  • reduceRight(callbackfn: function, initialValue: TypeField): TypeField
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns TypeField

  • Parameters

    Returns TypeField

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: TypeField, currentIndex: number, array: TypeField[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns TypeField[]

shift

  • Removes the first element from an array and returns it.

    Returns TypeField | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): TypeField[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns TypeField[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): TypeField[]
  • splice(start: number, deleteCount: number, ...items: TypeField[]): TypeField[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns TypeField[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: TypeField[]

      Elements to insert into the array in place of the deleted elements.

    Returns TypeField[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: TypeField[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<TypeField>

type

type: object

className

className: string = "TypeFieldListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TypeField"

name

name: "Composite" = "Composite"

Const UpdateConfiguration

UpdateConfiguration: object
interface

An interface representing UpdateConfiguration. Update specifc properties of the software update configuration.

Optional azureVirtualMachines

azureVirtualMachines: string[]
member

{string[]} [azureVirtualMachines] List of azure resource Ids for azure virtual machines targeted by the software update configuration.

Optional duration

duration: undefined | string
member

{string} [duration] Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601

Optional linux

member

{LinuxProperties} [linux] Linux specific update configuration.

Optional nonAzureComputerNames

nonAzureComputerNames: string[]
member

{string[]} [nonAzureComputerNames] List of names of non-azure machines targeted by the software update configuration.

operatingSystem

operatingSystem: OperatingSystemType
member

{OperatingSystemType} operatingSystem operating system of target machines. Possible values include: 'Windows', 'Linux'

Optional targets

member

{TargetProperties} [targets] Group targets for the software update configuration.

Optional windows

member

{WindowsProperties} [windows] Windows specific update configuration.

serializedName

serializedName: string = "updateConfiguration"

type

type: object

className

className: string = "UpdateConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureVirtualMachines

azureVirtualMachines: object

serializedName

serializedName: string = "azureVirtualMachines"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

duration

duration: object

serializedName

serializedName: string = "duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

linux

linux: object

serializedName

serializedName: string = "linux"

type

type: object

className

className: string = "LinuxProperties"

name

name: "Composite" = "Composite"

nonAzureComputerNames

nonAzureComputerNames: object

serializedName

serializedName: string = "nonAzureComputerNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

operatingSystem

operatingSystem: object

required

required: true = true

serializedName

serializedName: string = "operatingSystem"

type

type: object

allowedValues

allowedValues: string[] = ["Windows","Linux"]

name

name: "Enum" = "Enum"

targets

targets: object

serializedName

serializedName: string = "targets"

type

type: object

className

className: string = "TargetProperties"

name

name: "Composite" = "Composite"

windows

windows: object

serializedName

serializedName: string = "windows"

type

type: object

className

className: string = "WindowsProperties"

name

name: "Composite" = "Composite"

Const UpdateConfigurationNavigation

UpdateConfigurationNavigation: object
interface

An interface representing UpdateConfigurationNavigation. Software update configuration Run Navigation model.

Optional name

name: undefined | string
member

{string} [name] Name of the software update configuration triggered the software update configuration run NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "updateConfigurationNavigation"

type

type: object

className

className: string = "UpdateConfigurationNavigation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const Usage

Usage: object
interface

An interface representing Usage. Definition of Usage.

Optional currentValue

currentValue: undefined | number
member

{number} [currentValue] Gets or sets the current usage value.

Optional id

id: undefined | string
member

{string} [id] Gets or sets the id of the resource.

Optional limit

limit: undefined | number
member

{number} [limit] Gets or sets max limit. -1 for unlimited

Optional name

member

{UsageCounterName} [name] Gets or sets the usage counter name.

Optional throttleStatus

throttleStatus: undefined | string
member

{string} [throttleStatus] Gets or sets the throttle status.

Optional unit

unit: undefined | string
member

{string} [unit] Gets or sets the usage unit name.

serializedName

serializedName: string = "Usage"

type

type: object

className

className: string = "Usage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

serializedName

serializedName: string = "currentValue"

type

type: object

name

name: "Number" = "Number"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

limit

limit: object

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "UsageCounterName"

name

name: "Composite" = "Composite"

throttleStatus

throttleStatus: object

serializedName

serializedName: string = "throttleStatus"

type

type: object

name

name: "String" = "String"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const UsageCounterName

UsageCounterName: object
interface

An interface representing UsageCounterName. Definition of usage counter name.

Optional localizedValue

localizedValue: undefined | string
member

{string} [localizedValue] Gets or sets the localized usage counter name.

Optional value

value: undefined | string
member

{string} [value] Gets or sets the usage counter name.

serializedName

serializedName: string = "UsageCounterName"

type

type: object

className

className: string = "UsageCounterName"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValue

localizedValue: object

serializedName

serializedName: string = "localizedValue"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const UsageListResult

UsageListResult: object
interface

An interface representing the UsageListResult. The response model for the get usage operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "UsageListResult"

__@iterator

  • __@iterator(): IterableIterator<Usage>
  • Iterator

    Returns IterableIterator<Usage>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Usage>[]): Usage[]
  • concat(...items: (T | ConcatArray<T>)[]): Usage[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Usage>[]

      Additional items to add to the end of array1.

    Returns Usage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Usage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Usage]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Usage]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Usage, index: number, array: Usage[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Usage, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Usage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Usage[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): any
        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Usage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Usage | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Usage, index: number, obj: Usage[]): boolean
        • Parameters

          • this: void
          • value: Usage
          • index: number
          • obj: Usage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Usage, index: number, obj: Usage[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Usage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Usage, index: number, obj: Usage[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): void
        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Usage, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Usage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Usage, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Usage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Usage, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Usage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): U
        • Parameters

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Usage | undefined
  • Removes the last element from an array and returns it.

    Returns Usage | undefined

push

  • push(...items: Usage[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Usage[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Usage
  • reduce(callbackfn: function, initialValue: Usage): Usage
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Usage

  • Parameters

    • callbackfn: function
    • initialValue: Usage

    Returns Usage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Usage, currentIndex: number, array: Usage[]): U
        • Parameters

          • previousValue: U
          • currentValue: Usage
          • currentIndex: number
          • array: Usage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Usage
  • reduceRight(callbackfn: function, initialValue: Usage): Usage
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Usage

  • Parameters

    • callbackfn: function
    • initialValue: Usage

    Returns Usage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Usage, currentIndex: number, array: Usage[]): U
        • Parameters

          • previousValue: U
          • currentValue: Usage
          • currentIndex: number
          • array: Usage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Usage[]

shift

  • shift(): Usage | undefined
  • Removes the first element from an array and returns it.

    Returns Usage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Usage[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Usage[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Usage, index: number, array: Usage[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Usage[]
  • splice(start: number, deleteCount: number, ...items: Usage[]): Usage[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Usage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Usage[]

      Elements to insert into the array in place of the deleted elements.

    Returns Usage[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Usage[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Usage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Usage>
  • Returns an iterable of values in the array

    Returns IterableIterator<Usage>

type

type: object

className

className: string = "UsageListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Usage"

name

name: "Composite" = "Composite"

Const Variable

Variable: object
interface

An interface representing Variable. Definition of the varible.

extends

ProxyResource

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional isEncrypted

isEncrypted: undefined | false | true
member

{boolean} [isEncrypted] Gets or sets the encrypted flag of the variable.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional value

value: undefined | string
member

{string} [value] Gets or sets the value of the variable.

serializedName

serializedName: string = "Variable"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Variable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isEncrypted

isEncrypted: object

nullable

nullable: true = true

serializedName

serializedName: string = "properties.isEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

value

value: object

serializedName

serializedName: string = "properties.value"

type

type: object

name

name: "String" = "String"

Const VariableCreateOrUpdateParameters

VariableCreateOrUpdateParameters: object
interface

An interface representing VariableCreateOrUpdateParameters. The parameters supplied to the create or update variable operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the variable.

Optional isEncrypted

isEncrypted: undefined | false | true
member

{boolean} [isEncrypted] Gets or sets the encrypted flag of the variable.

name

name: string
member

{string} name Gets or sets the name of the variable.

Optional value

value: undefined | string
member

{string} [value] Gets or sets the value of the variable.

serializedName

serializedName: string = "VariableCreateOrUpdateParameters"

type

type: object

className

className: string = "VariableCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isEncrypted

isEncrypted: object

serializedName

serializedName: string = "properties.isEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "properties.value"

type

type: object

name

name: "String" = "String"

Const VariableListResult

VariableListResult: object
interface

An interface representing the VariableListResult. The response model for the list variables operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "VariableListResult"

__@iterator

  • __@iterator(): IterableIterator<Variable>
  • Iterator

    Returns IterableIterator<Variable>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Variable>[]

      Additional items to add to the end of array1.

    Returns Variable[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Variable[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Variable]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Variable]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Variable, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Variable

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Variable[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Variable[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Variable | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Variable | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Variable, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Variable

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Variable, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Variable

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Variable, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Variable

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Variable | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Variable[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Variable
  • reduce(callbackfn: function, initialValue: Variable): Variable
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Variable

  • Parameters

    Returns Variable

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Variable, currentIndex: number, array: Variable[]): U
        • Parameters

          • previousValue: U
          • currentValue: Variable
          • currentIndex: number
          • array: Variable[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Variable
  • reduceRight(callbackfn: function, initialValue: Variable): Variable
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Variable

  • Parameters

    Returns Variable

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Variable, currentIndex: number, array: Variable[]): U
        • Parameters

          • previousValue: U
          • currentValue: Variable
          • currentIndex: number
          • array: Variable[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Variable[]

shift

  • Removes the first element from an array and returns it.

    Returns Variable | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Variable[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Variable[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Variable[]
  • splice(start: number, deleteCount: number, ...items: Variable[]): Variable[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Variable[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Variable[]

      Elements to insert into the array in place of the deleted elements.

    Returns Variable[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Variable[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Variable>

type

type: object

className

className: string = "VariableListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Variable"

name

name: "Composite" = "Composite"

Const VariableUpdateParameters

VariableUpdateParameters: object
interface

An interface representing VariableUpdateParameters. The parameters supplied to the update variable operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the variable.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the variable.

Optional value

value: undefined | string
member

{string} [value] Gets or sets the value of the variable.

serializedName

serializedName: string = "VariableUpdateParameters"

type

type: object

className

className: string = "VariableUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "properties.value"

type

type: object

name

name: "String" = "String"

Const Watcher

Watcher: object
interface

An interface representing Watcher. Definition of the watcher type.

extends

TrackedResource

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional etag

etag: undefined | string
member

{string} [etag] Gets or sets the etag of the resource.

Optional executionFrequencyInSeconds

executionFrequencyInSeconds: undefined | number
member

{number} [executionFrequencyInSeconds] Gets or sets the frequency at which the watcher is invoked.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedBy

lastModifiedBy: undefined | string
member

{string} [lastModifiedBy] Details of the user who last modified the watcher. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] The Azure Region where the resource lives

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional scriptName

scriptName: undefined | string
member

{string} [scriptName] Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.

Optional scriptParameters

scriptParameters: undefined | object
member

{{ [propertyName: string]: string }} [scriptParameters] Gets or sets the parameters of the script.

Optional scriptRunOn

scriptRunOn: undefined | string
member

{string} [scriptRunOn] Gets or sets the name of the hybrid worker group the watcher will run on.

Optional status

status: undefined | string
member

{string} [status] Gets the current status of the watcher. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

serializedName

serializedName: string = "Watcher"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Watcher"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

executionFrequencyInSeconds

executionFrequencyInSeconds: object

serializedName

serializedName: string = "properties.executionFrequencyInSeconds"

type

type: object

name

name: "Number" = "Number"

lastModifiedBy

lastModifiedBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedBy"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

scriptName

scriptName: object

serializedName

serializedName: string = "properties.scriptName"

type

type: object

name

name: "String" = "String"

scriptParameters

scriptParameters: object

serializedName

serializedName: string = "properties.scriptParameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

scriptRunOn

scriptRunOn: object

serializedName

serializedName: string = "properties.scriptRunOn"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

Const WatcherListResult

WatcherListResult: object
interface

An interface representing the WatcherListResult. The response model for the list watcher operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "WatcherListResult"

__@iterator

  • __@iterator(): IterableIterator<Watcher>
  • Iterator

    Returns IterableIterator<Watcher>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Watcher>[]): Watcher[]
  • concat(...items: (T | ConcatArray<T>)[]): Watcher[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Watcher>[]

      Additional items to add to the end of array1.

    Returns Watcher[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Watcher[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Watcher]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Watcher]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Watcher, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Watcher

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Watcher[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Watcher[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Watcher | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Watcher, index: number, obj: Watcher[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Watcher | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Watcher, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Watcher

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Watcher, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Watcher

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Watcher, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Watcher

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Watcher | undefined

push

  • push(...items: Watcher[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Watcher[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Watcher
  • reduce(callbackfn: function, initialValue: Watcher): Watcher
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Watcher

  • Parameters

    Returns Watcher

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Watcher, currentIndex: number, array: Watcher[]): U
        • Parameters

          • previousValue: U
          • currentValue: Watcher
          • currentIndex: number
          • array: Watcher[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Watcher
  • reduceRight(callbackfn: function, initialValue: Watcher): Watcher
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Watcher

  • Parameters

    Returns Watcher

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Watcher, currentIndex: number, array: Watcher[]): U
        • Parameters

          • previousValue: U
          • currentValue: Watcher
          • currentIndex: number
          • array: Watcher[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Watcher[]

shift

  • Removes the first element from an array and returns it.

    Returns Watcher | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Watcher[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Watcher[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Watcher[]
  • splice(start: number, deleteCount: number, ...items: Watcher[]): Watcher[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Watcher[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Watcher[]

      Elements to insert into the array in place of the deleted elements.

    Returns Watcher[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Watcher[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Watcher[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Watcher>
  • Returns an iterable of values in the array

    Returns IterableIterator<Watcher>

type

type: object

className

className: string = "WatcherListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Watcher"

name

name: "Composite" = "Composite"

Const WatcherUpdateParameters

WatcherUpdateParameters: object
interface

An interface representing WatcherUpdateParameters.

Optional executionFrequencyInSeconds

executionFrequencyInSeconds: undefined | number
member

{number} [executionFrequencyInSeconds] Gets or sets the frequency at which the watcher is invoked.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the resource.

serializedName

serializedName: string = "WatcherUpdateParameters"

type

type: object

className

className: string = "WatcherUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

executionFrequencyInSeconds

executionFrequencyInSeconds: object

serializedName

serializedName: string = "properties.executionFrequencyInSeconds"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const Webhook

Webhook: object
interface

An interface representing Webhook. Definition of the webhook type.

extends

ProxyResource

Optional creationTime

creationTime: Date
member

{Date} [creationTime] Gets or sets the creation time.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description.

Optional expiryTime

expiryTime: Date
member

{Date} [expiryTime] Gets or sets the expiry time.

Optional id

id: undefined | string
member

{string} [id] Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional isEnabled

isEnabled: undefined | false | true
member

{boolean} [isEnabled] Gets or sets the value of the enabled flag of the webhook. Default value: false .

Optional lastInvokedTime

lastInvokedTime: Date
member

{Date} [lastInvokedTime] Gets or sets the last invoked time.

Optional lastModifiedBy

lastModifiedBy: undefined | string
member

{string} [lastModifiedBy] Details of the user who last modified the Webhook

Optional lastModifiedTime

lastModifiedTime: Date
member

{Date} [lastModifiedTime] Gets or sets the last modified time.

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.

Optional runOn

runOn: undefined | string
member

{string} [runOn] Gets or sets the name of the hybrid worker group the webhook job will run on.

Optional runbook

member

{RunbookAssociationProperty} [runbook] Gets or sets the runbook the webhook is associated with.

Optional uri

uri: undefined | string
member

{string} [uri] Gets or sets the webhook uri.

serializedName

serializedName: string = "Webhook"

Optional type

type: object
member

{string} [type] The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Webhook"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

expiryTime

expiryTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

isEnabled

isEnabled: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.isEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

lastInvokedTime

lastInvokedTime: object

nullable

nullable: true = true

serializedName

serializedName: string = "properties.lastInvokedTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastModifiedBy

lastModifiedBy: object

serializedName

serializedName: string = "properties.lastModifiedBy"

type

type: object

name

name: "String" = "String"

lastModifiedTime

lastModifiedTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.lastModifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "properties.runOn"

type

type: object

name

name: "String" = "String"

runbook

runbook: object

serializedName

serializedName: string = "properties.runbook"

type

type: object

className

className: string = "RunbookAssociationProperty"

name

name: "Composite" = "Composite"

uri

uri: object

serializedName

serializedName: string = "properties.uri"

type

type: object

name

name: "String" = "String"

Const WebhookCreateOrUpdateParameters

WebhookCreateOrUpdateParameters: object
interface

An interface representing WebhookCreateOrUpdateParameters. The parameters supplied to the create or update webhook operation.

Optional expiryTime

expiryTime: Date
member

{Date} [expiryTime] Gets or sets the expiry time.

Optional isEnabled

isEnabled: undefined | false | true
member

{boolean} [isEnabled] Gets or sets the value of the enabled flag of webhook.

name

name: string
member

{string} name Gets or sets the name of the webhook.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the job.

Optional runOn

runOn: undefined | string
member

{string} [runOn] Gets or sets the name of the hybrid worker group the webhook job will run on.

Optional runbook

member

{RunbookAssociationProperty} [runbook] Gets or sets the runbook.

Optional uri

uri: undefined | string
member

{string} [uri] Gets or sets the uri.

serializedName

serializedName: string = "WebhookCreateOrUpdateParameters"

type

type: object

className

className: string = "WebhookCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiryTime

expiryTime: object

nullable

nullable: false = false

serializedName

serializedName: string = "properties.expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

isEnabled

isEnabled: object

serializedName

serializedName: string = "properties.isEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "properties.runOn"

type

type: object

name

name: "String" = "String"

runbook

runbook: object

serializedName

serializedName: string = "properties.runbook"

type

type: object

className

className: string = "RunbookAssociationProperty"

name

name: "Composite" = "Composite"

uri

uri: object

serializedName

serializedName: string = "properties.uri"

type

type: object

name

name: "String" = "String"

Const WebhookListResult

WebhookListResult: object
interface

An interface representing the WebhookListResult. The response model for the list webhook operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Gets or sets the next link.

serializedName

serializedName: string = "WebhookListResult"

__@iterator

  • __@iterator(): IterableIterator<Webhook>
  • Iterator

    Returns IterableIterator<Webhook>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Webhook>[]): Webhook[]
  • concat(...items: (T | ConcatArray<T>)[]): Webhook[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Webhook>[]

      Additional items to add to the end of array1.

    Returns Webhook[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Webhook[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Webhook]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Webhook]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Webhook, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Webhook

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Webhook[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Webhook[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Webhook | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Webhook, index: number, obj: Webhook[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Webhook | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Webhook, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Webhook

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Webhook, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Webhook

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Webhook, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Webhook

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Webhook | undefined

push

  • push(...items: Webhook[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Webhook[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Webhook
  • reduce(callbackfn: function, initialValue: Webhook): Webhook
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Webhook

  • Parameters

    Returns Webhook

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Webhook, currentIndex: number, array: Webhook[]): U
        • Parameters

          • previousValue: U
          • currentValue: Webhook
          • currentIndex: number
          • array: Webhook[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Webhook
  • reduceRight(callbackfn: function, initialValue: Webhook): Webhook
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Webhook

  • Parameters

    Returns Webhook

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Webhook, currentIndex: number, array: Webhook[]): U
        • Parameters

          • previousValue: U
          • currentValue: Webhook
          • currentIndex: number
          • array: Webhook[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Webhook[]

shift

  • Removes the first element from an array and returns it.

    Returns Webhook | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Webhook[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Webhook[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Webhook[]
  • splice(start: number, deleteCount: number, ...items: Webhook[]): Webhook[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Webhook[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Webhook[]

      Elements to insert into the array in place of the deleted elements.

    Returns Webhook[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Webhook[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Webhook[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Webhook>
  • Returns an iterable of values in the array

    Returns IterableIterator<Webhook>

type

type: object

className

className: string = "WebhookListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Webhook"

name

name: "Composite" = "Composite"

Const WebhookUpdateParameters

WebhookUpdateParameters: object
interface

An interface representing WebhookUpdateParameters. The parameters supplied to the update webhook operation.

Optional description

description: undefined | string
member

{string} [description] Gets or sets the description of the webhook.

Optional isEnabled

isEnabled: undefined | false | true
member

{boolean} [isEnabled] Gets or sets the value of the enabled flag of webhook.

Optional name

name: undefined | string
member

{string} [name] Gets or sets the name of the webhook.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] Gets or sets the parameters of the job.

Optional runOn

runOn: undefined | string
member

{string} [runOn] Gets or sets the name of the hybrid worker group the webhook job will run on.

serializedName

serializedName: string = "WebhookUpdateParameters"

type

type: object

className

className: string = "WebhookUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isEnabled

isEnabled: object

serializedName

serializedName: string = "properties.isEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

runOn

runOn: object

serializedName

serializedName: string = "properties.runOn"

type

type: object

name

name: "String" = "String"

Const WindowsProperties

WindowsProperties: object
interface

An interface representing WindowsProperties. Windows specific update configuration.

Optional excludedKbNumbers

excludedKbNumbers: string[]
member

{string[]} [excludedKbNumbers] KB numbers excluded from the software update configuration.

Optional includedKbNumbers

includedKbNumbers: string[]
member

{string[]} [includedKbNumbers] KB numbers included from the software update configuration.

Optional includedUpdateClassifications

includedUpdateClassifications: WindowsUpdateClasses
member

{WindowsUpdateClasses} [includedUpdateClassifications] Update classification included in the software update configuration. A comma separated string with required values. Possible values include: 'Unclassified', 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', 'Updates'

Optional rebootSetting

rebootSetting: undefined | string
member

{string} [rebootSetting] Reboot setting for the software update configuration.

serializedName

serializedName: string = "WindowsProperties"

type

type: object

className

className: string = "WindowsProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

excludedKbNumbers

excludedKbNumbers: object

serializedName

serializedName: string = "excludedKbNumbers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

includedKbNumbers

includedKbNumbers: object

serializedName

serializedName: string = "includedKbNumbers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

includedUpdateClassifications

includedUpdateClassifications: object

serializedName

serializedName: string = "includedUpdateClassifications"

type

type: object

name

name: "String" = "String"

rebootSetting

rebootSetting: object

serializedName

serializedName: string = "rebootSetting"

type

type: object

name

name: "String" = "String"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const activityName

activityName: object

parameterPath

parameterPath: string = "activityName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "activityName"

type

type: object

name

name: "String" = "String"

Const apiVersion0

apiVersion0: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2015-10-31"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion1

apiVersion1: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2017-05-15-preview"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion2

apiVersion2: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2018-01-15"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion3

apiVersion3: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2018-06-30"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const automationAccountName

automationAccountName: object

parameterPath

parameterPath: string = "automationAccountName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "automationAccountName"

type

type: object

name

name: "String" = "String"

Const certificateName

certificateName: object

parameterPath

parameterPath: string = "certificateName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "certificateName"

type

type: object

name

name: "String" = "String"

Const clientRequestId

clientRequestId: object

parameterPath

parameterPath: string[] = ["options","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

name: "String" = "String"

Const compilationJobName

compilationJobName: object

parameterPath

parameterPath: string = "compilationJobName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "compilationJobName"

type

type: object

name

name: "String" = "String"

Const configurationName

configurationName: object

parameterPath

parameterPath: string = "configurationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "configurationName"

type

type: object

name

name: "String" = "String"

Const connectionName

connectionName: object

parameterPath

parameterPath: string = "connectionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "connectionName"

type

type: object

name

name: "String" = "String"

Const connectionTypeName

connectionTypeName: object

parameterPath

parameterPath: string = "connectionTypeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "connectionTypeName"

type

type: object

name

name: "String" = "String"

Const countType

countType: object

parameterPath

parameterPath: string = "countType"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "countType"

type

type: object

name

name: "String" = "String"

Const credentialName

credentialName: object

parameterPath

parameterPath: string = "credentialName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "credentialName"

type

type: object

name

name: "String" = "String"

Const filter

filter: object

parameterPath

parameterPath: string[] = ["options","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const hybridRunbookWorkerGroupName

hybridRunbookWorkerGroupName: object

parameterPath

parameterPath: string = "hybridRunbookWorkerGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "hybridRunbookWorkerGroupName"

type

type: object

name

name: "String" = "String"

Const inlinecount

inlinecount: object

parameterPath

parameterPath: string[] = ["options","inlinecount"]

mapper

mapper: object

serializedName

serializedName: string = "$inlinecount"

type

type: object

name

name: "String" = "String"

Const jobId

jobId: object

parameterPath

parameterPath: string = "jobId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobId"

type

type: object

name

name: "Uuid" = "Uuid"

Const jobName

jobName: object

parameterPath

parameterPath: string = "jobName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobName"

type

type: object

name

name: "String" = "String"

Const jobScheduleId

jobScheduleId: object

parameterPath

parameterPath: string = "jobScheduleId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobScheduleId"

type

type: object

name

name: "Uuid" = "Uuid"

Const jobStreamId

jobStreamId: object

parameterPath

parameterPath: string = "jobStreamId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobStreamId"

type

type: object

name

name: "String" = "String"

Const moduleName

moduleName: object

parameterPath

parameterPath: string = "moduleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "moduleName"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const nodeConfigurationName

nodeConfigurationName: object

parameterPath

parameterPath: string = "nodeConfigurationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nodeConfigurationName"

type

type: object

name

name: "String" = "String"

Const nodeId

nodeId: object

parameterPath

parameterPath: string = "nodeId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nodeId"

type

type: object

name

name: "String" = "String"

Const packageName

packageName: object

parameterPath

parameterPath: string = "packageName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "packageName"

type

type: object

name

name: "String" = "String"

Const reportId

reportId: object

parameterPath

parameterPath: string = "reportId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "reportId"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

constraints

constraints: object

MaxLength

MaxLength: number = 90

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[-\w\._]+$/

type

type: object

name

name: "String" = "String"

Const runbookName

runbookName: object

parameterPath

parameterPath: string = "runbookName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "runbookName"

type

type: object

name

name: "String" = "String"

Const scheduleName

scheduleName: object

parameterPath

parameterPath: string = "scheduleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "scheduleName"

type

type: object

name

name: "String" = "String"

Const skip0

skip0: object

parameterPath

parameterPath: string[] = ["options","skip"]

mapper

mapper: object

serializedName

serializedName: string = "$skip"

type

type: object

name

name: "Number" = "Number"

Const skip1

skip1: object

parameterPath

parameterPath: string[] = ["options","skip"]

mapper

mapper: object

serializedName

serializedName: string = "$skip"

type

type: object

name

name: "String" = "String"

Const softwareUpdateConfigurationMachineRunId

softwareUpdateConfigurationMachineRunId: object

parameterPath

parameterPath: string = "softwareUpdateConfigurationMachineRunId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "softwareUpdateConfigurationMachineRunId"

type

type: object

name

name: "Uuid" = "Uuid"

Const softwareUpdateConfigurationName

softwareUpdateConfigurationName: object

parameterPath

parameterPath: string = "softwareUpdateConfigurationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "softwareUpdateConfigurationName"

type

type: object

name

name: "String" = "String"

Const softwareUpdateConfigurationRunId

softwareUpdateConfigurationRunId: object

parameterPath

parameterPath: string = "softwareUpdateConfigurationRunId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "softwareUpdateConfigurationRunId"

type

type: object

name

name: "Uuid" = "Uuid"

Const sourceControlName

sourceControlName: object

parameterPath

parameterPath: string = "sourceControlName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "sourceControlName"

type

type: object

name

name: "String" = "String"

Const sourceControlSyncJobId

sourceControlSyncJobId: object

parameterPath

parameterPath: string = "sourceControlSyncJobId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "sourceControlSyncJobId"

type

type: object

name

name: "Uuid" = "Uuid"

Const streamId

streamId: object

parameterPath

parameterPath: string = "streamId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "streamId"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const top0

top0: object

parameterPath

parameterPath: string[] = ["options","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: "Number" = "Number"

Const top1

top1: object

parameterPath

parameterPath: string[] = ["options","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: "String" = "String"

Const typeName

typeName: object

parameterPath

parameterPath: string = "typeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "typeName"

type

type: object

name

name: "String" = "String"

Const variableName

variableName: object

parameterPath

parameterPath: string = "variableName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "variableName"

type

type: object

name

name: "String" = "String"

Const watcherName

watcherName: object

parameterPath

parameterPath: string = "watcherName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "watcherName"

type

type: object

name

name: "String" = "String"

Const webhookName

webhookName: object

parameterPath

parameterPath: string = "webhookName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "webhookName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc